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 "consolecolors.h"
  53 #include "caller.h"
  54 #include "cull_list.h"
  55 #include "extensible.h"
  56 #include "numerics.h"
  57 #include "uid.h"
  58 #include "users.h"
  59 #include "channels.h"
  60 #include "timer.h"
  61 #include "hashcomp.h"
  62 #include "logger.h"
  63 #include "usermanager.h"
  64 #include "socket.h"
  65 #include "ctables.h"
  66 #include "command_parse.h"
  67 #include "mode.h"
  68 #include "socketengine.h"
  69 #include "snomasks.h"
  70 #include "filelogger.h"
  71 #include "modules.h"
  72 #include "threadengine.h"
  73 #include "configreader.h"
  74 #include "inspstring.h"
  75 #include "protocol.h"
  76
  77 /** Returned by some functions to indicate failure.
  78  */
  79 #define ERROR -1
  80
  81 /** Template function to convert any input type to std::string
  82  */
  83 template<typename T> inline std::string ConvNumeric(const T &in)
  84 {
  85         if (in == 0)
  86                 return "0";
  87         T quotient = in;
  88         std::string out;
  89         while (quotient)
  90         {
  91                 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
  92                 quotient /= 10;
  93         }
  94         if (in < 0)
  95                 out += '-';
  96         std::reverse(out.begin(), out.end());
  97         return out;
  98 }
  99
 100 /** Template function to convert any input type to std::string
 101  */
 102 inline std::string ConvToStr(const int in)
 103 {
 104         return ConvNumeric(in);
 105 }
 106
 107 /** Template function to convert any input type to std::string
 108  */
 109 inline std::string ConvToStr(const long in)
 110 {
 111         return ConvNumeric(in);
 112 }
 113
 114 /** Template function to convert any input type to std::string
 115  */
 116 inline std::string ConvToStr(const char* in)
 117 {
 118         return in;
 119 }
 120
 121 /** Template function to convert any input type to std::string
 122  */
 123 inline std::string ConvToStr(const bool in)
 124 {
 125         return (in ? "1" : "0");
 126 }
 127
 128 /** Template function to convert any input type to std::string
 129  */
 130 inline std::string ConvToStr(char in)
 131 {
 132         return std::string(in,1);
 133 }
 134
 135 /** Template function to convert any input type to std::string
 136  */
 137 template <class T> inline std::string ConvToStr(const T &in)
 138 {
 139         std::stringstream tmp;
 140         if (!(tmp << in)) return std::string();
 141         return tmp.str();
 142 }
 143
 144 /** Template function to convert any input type to any other type
 145  * (usually an integer or numeric type)
 146  */
 147 template<typename T> inline long ConvToInt(const T &in)
 148 {
 149         std::stringstream tmp;
 150         if (!(tmp << in)) return 0;
 151         return atol(tmp.str().c_str());
 152 }
 153
 154 /** This class contains various STATS counters
 155  * It is used by the InspIRCd class, which internally
 156  * has an instance of it.
 157  */
 158 class serverstats
 159 {
 160   public:
 161         /** Number of accepted connections
 162          */
 163         unsigned long statsAccept;
 164         /** Number of failed accepts
 165          */
 166         unsigned long statsRefused;
 167         /** Number of unknown commands seen
 168          */
 169         unsigned long statsUnknown;
 170         /** Number of nickname collisions handled
 171          */
 172         unsigned long statsCollisions;
 173         /** Number of DNS queries sent out
 174          */
 175         unsigned long statsDns;
 176         /** Number of good DNS replies received
 177          * NOTE: This may not tally to the number sent out,
 178          * due to timeouts and other latency issues.
 179          */
 180         unsigned long statsDnsGood;
 181         /** Number of bad (negative) 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 statsDnsBad;
 186         /** Number of inbound connections seen
 187          */
 188         unsigned long statsConnects;
 189         /** Total bytes of data transmitted
 190          */
 191         unsigned long statsSent;
 192         /** Total bytes of data received
 193          */
 194         unsigned long statsRecv;
 195 #ifdef _WIN32
 196         /** Cpu usage at last sample
 197         */
 198         FILETIME LastCPU;
 199         /** Time QP sample was read
 200         */
 201         LARGE_INTEGER LastSampled;
 202         /** QP frequency
 203         */
 204         LARGE_INTEGER QPFrequency;
 205 #else
 206         /** Cpu usage at last sample
 207          */
 208         timeval LastCPU;
 209         /** Time last sample was read
 210          */
 211         timespec LastSampled;
 212 #endif
 213         /** The constructor initializes all the counts to zero
 214          */
 215         serverstats()
 216                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
 217                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
 218         {
 219         }
 220 };
 221
 222 /** This class manages the generation and transmission of ISUPPORT. */
 223 class CoreExport ISupportManager
 224 {
 225 private:
 226         /** The generated lines which are sent to clients. */
 227         std::vector<std::string> Lines;
 228
 229 public:
 230         /** (Re)build the ISUPPORT vector. */
 231         void Build();
 232
 233         /** Returns the std::vector of ISUPPORT lines. */
 234         const std::vector<std::string>& GetLines()
 235         {
 236                 return this->Lines;
 237         }
 238
 239         /** Send the 005 numerics (ISUPPORT) to a user. */
 240         void SendTo(LocalUser* user);
 241 };
 242
 243 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
 244 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 245 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
 246 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
 247 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 248 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 249
 250 /** The main class of the irc server.
 251  * This class contains instances of all the other classes in this software.
 252  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 253  * object, and a list of active Module objects, and facilities for Module
 254  * objects to interact with the core system it implements.
 255  */
 256 class CoreExport InspIRCd
 257 {
 258  private:
 259         /** Set up the signal handlers
 260          */
 261         void SetSignals();
 262
 263         /** Daemonize the ircd and close standard input/output streams
 264          * @return True if the program daemonized succesfully
 265          */
 266         bool DaemonSeed();
 267
 268         /** The current time, updated in the mainloop
 269          */
 270         struct timespec TIME;
 271
 272         /** A 64k buffer used to read socket data into
 273          * NOTE: update ValidateNetBufferSize if you change this
 274          */
 275         char ReadBuffer[65535];
 276
 277         /** Check we aren't running as root, and exit if we are
 278          * with exit code EXIT_STATUS_ROOT.
 279          */
 280         void CheckRoot();
 281
 282  public:
 283
 284         UIDGenerator UIDGen;
 285
 286         /** Global cull list, will be processed on next iteration
 287          */
 288         CullList GlobalCulls;
 289         /** Actions that must happen outside of the current call stack */
 290         ActionList AtomicActions;
 291
 292         /**** Functors ****/
 293
 294         IsNickHandler HandleIsNick;
 295         IsIdentHandler HandleIsIdent;
 296         OnCheckExemptionHandler HandleOnCheckExemption;
 297         IsChannelHandler HandleIsChannel;
 298         RehashHandler HandleRehash;
 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         LocalStringExt 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         /** Rehash the local server
 486          */
 487         caller1<void, const std::string&> Rehash;
 488
 489         /** Handles incoming signals after being set
 490          * @param signal the signal recieved
 491          */
 492         void SignalHandler(int signal);
 493
 494         /** Sets the signal recieved
 495          * @param signal the signal recieved
 496          */
 497         static void SetSignal(int signal);
 498
 499         /** Causes the server to exit after unloading modules and
 500          * closing all open file descriptors.
 501          *
 502          * @param status The exit code to give to the operating system
 503          * (See the ExitStatus enum for valid values)
 504          */
 505         void Exit(int status);
 506
 507         /** Causes the server to exit immediately with exit code 0.
 508          * The status code is required for signal handlers, and ignored.
 509          */
 510         static void QuickExit(int status);
 511
 512         /** Formats the input string with the specified arguments.
 513         * @param formatString The string to format
 514         * @param ... A variable number of format arguments.
 515         * @return The formatted string
 516         */
 517         static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
 518         static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 519
 520         /** Return a count of channels on the network
 521          * @return The number of channels
 522          */
 523         long ChannelCount() const { return chanlist->size(); }
 524
 525         /** Send an error notice to all local users, opered and unopered
 526          * @param s The error string to send
 527          */
 528         void SendError(const std::string &s);
 529
 530         /** Return true if a nickname is valid
 531          * @param n A nickname to verify
 532          * @return True if the nick is valid
 533          */
 534         caller1<bool, const std::string&> IsNick;
 535
 536         /** Return true if an ident is valid
 537          * @param An ident to verify
 538          * @return True if the ident is valid
 539          */
 540         caller1<bool, const std::string&> IsIdent;
 541
 542         /** Match two strings using pattern matching, optionally, with a map
 543          * to check case against (may be NULL). If map is null, match will be case insensitive.
 544          * @param str The literal string to match against
 545          * @param mask The glob pattern to match against.
 546          * @param map The character map to use when matching.
 547          */
 548         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 549         static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
 550
 551         /** Match two strings using pattern matching, optionally, with a map
 552          * to check case against (may be NULL). If map is null, match will be case insensitive.
 553          * Supports CIDR patterns as well as globs.
 554          * @param str The literal string to match against
 555          * @param mask The glob or CIDR pattern to match against.
 556          * @param map The character map to use when matching.
 557          */
 558         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 559         static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
 560
 561         /** Matches a hostname and IP against a space delimited list of hostmasks.
 562          * @param masks The space delimited masks to match against.
 563          * @param hostname The hostname to try and match.
 564          * @param ipaddr The IP address to try and match.
 565          */
 566         static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 567
 568         /** Return true if the given parameter is a valid nick!user\@host mask
 569          * @param mask A nick!user\@host masak to match against
 570          * @return True i the mask is valid
 571          */
 572         bool IsValidMask(const std::string &mask);
 573
 574         /** Strips all color codes from the given string
 575          * @param sentence The string to strip from
 576          */
 577         static void StripColor(std::string &sentence);
 578
 579         /** Parses color codes from string values to actual color codes
 580          * @param input The data to process
 581          */
 582         static void ProcessColors(file_cache& input);
 583
 584         /** Rehash the local server
 585          */
 586         void RehashServer();
 587
 588         /** Check if the given nickmask matches too many users, send errors to the given user
 589          * @param nick A nickmask to match against
 590          * @param user A user to send error text to
 591          * @return True if the nick matches too many users
 592          */
 593         bool NickMatchesEveryone(const std::string &nick, User* user);
 594
 595         /** Check if the given IP mask matches too many users, send errors to the given user
 596          * @param ip An ipmask to match against
 597          * @param user A user to send error text to
 598          * @return True if the ip matches too many users
 599          */
 600         bool IPMatchesEveryone(const std::string &ip, User* user);
 601
 602         /** Check if the given hostmask matches too many users, send errors to the given user
 603          * @param mask A hostmask to match against
 604          * @param user A user to send error text to
 605          * @return True if the host matches too many users
 606          */
 607         bool HostMatchesEveryone(const std::string &mask, User* user);
 608
 609         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 610          * @param str A string containing a time in the form 1y2w3d4h6m5s
 611          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 612          * @return The total number of seconds
 613          */
 614         static unsigned long Duration(const std::string& str);
 615
 616         /** Attempt to compare a password to a string from the config file.
 617          * This will be passed to handling modules which will compare the data
 618          * against possible hashed equivalents in the input string.
 619          * @param ex The object (user, server, whatever) causing the comparison.
 620          * @param data The data from the config file
 621          * @param input The data input by the oper
 622          * @param hashtype The hash from the config file
 623          * @return 0 if the strings match, 1 or -1 if they do not
 624          */
 625         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 626
 627         /** Check if a given server is a uline.
 628          * An empty string returns true, this is by design.
 629          * @param server The server to check for uline status
 630          * @return True if the server is a uline OR the string is empty
 631          */
 632         bool ULine(const std::string& server);
 633
 634         /** Returns true if the uline is 'silent' (doesnt generate
 635          * remote connect notices etc).
 636          */
 637         bool SilentULine(const std::string& server);
 638
 639         /** Returns the full version string of this ircd
 640          * @return The version string
 641          */
 642         std::string GetVersionString(bool getFullVersion = false);
 643
 644         /** Attempt to write the process id to a given file
 645          * @param filename The PID file to attempt to write to
 646          * @return This function may bail if the file cannot be written
 647          */
 648         void WritePID(const std::string &filename);
 649
 650         /** This constructor initialises all the subsystems and reads the config file.
 651          * @param argc The argument count passed to main()
 652          * @param argv The argument list passed to main()
 653          * @throw <anything> If anything is thrown from here and makes it to
 654          * you, you should probably just give up and go home. Yes, really.
 655          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 656          */
 657         InspIRCd(int argc, char** argv);
 658
 659         /** Send a line of WHOIS data to a user.
 660          * @param user user to send the line to
 661          * @param dest user being WHOISed
 662          * @param numeric Numeric to send
 663          * @param text Text of the numeric
 664          */
 665         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 666
 667         /** Send a line of WHOIS data to a user.
 668          * @param user user to send the line to
 669          * @param dest user being WHOISed
 670          * @param numeric Numeric to send
 671          * @param format Format string for the numeric
 672          * @param ... Parameters for the format string
 673          */
 674         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 675
 676         /** Called to check whether a channel restriction mode applies to a user
 677          * @param User that is attempting some action
 678          * @param Channel that the action is being performed on
 679          * @param Action name
 680          */
 681         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 682
 683         /** Prepare the ircd for restart or shutdown.
 684          * This function unloads all modules which can be unloaded,
 685          * closes all open sockets, and closes the logfile.
 686          */
 687         void Cleanup();
 688
 689         /** Return a time_t as a human-readable string.
 690          */
 691         std::string TimeString(time_t curtime);
 692
 693         /** Begin execution of the server.
 694          * NOTE: this function NEVER returns. Internally,
 695          * it will repeatedly loop.
 696          */
 697         void Run();
 698
 699         char* GetReadBuffer()
 700         {
 701                 return this->ReadBuffer;
 702         }
 703 };
 704
 705 ENTRYPOINT;
 706
 707 template<class Cmd>
 708 class CommandModule : public Module
 709 {
 710         Cmd cmd;
 711  public:
 712         CommandModule() : cmd(this)
 713         {
 714         }
 715
 716         void init()
 717         {
 718                 ServerInstance->Modules->AddService(cmd);
 719         }
 720
 721         Version GetVersion()
 722         {
 723                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 724         }
 725 };