include/inspircd.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __INSPIRCD_H__
  15 #define __INSPIRCD_H__
  16
  17 #define _FILE_OFFSET_BITS 64
  18 #ifndef _LARGEFILE_SOURCE
  19 #define _LARGEFILE_SOURCE
  20 #endif
  21
  22 #ifndef WIN32
  23 #define DllExport
  24 #define CoreExport
  25 #define printf_c printf
  26 #else
  27 #include "inspircd_win32wrapper.h"
  28 /** Windows defines these already */
  29 #undef ERROR
  30 #endif
  31
  32 #ifdef __GNUC__
  33 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
  34 #else
  35 #define CUSTOM_PRINTF(STRING, FIRST)
  36 #endif
  37
  38 // Required system headers.
  39 #include <ctime>
  40 #include <cstdarg>
  41 #include <algorithm>
  42 #include <cmath>
  43 #include <cstring>
  44 #include <climits>
  45 #include <cstdio>
  46
  47 #include <sstream>
  48 #include <string>
  49 #include <vector>
  50 #include <list>
  51 #include <deque>
  52 #include <map>
  53 #include <bitset>
  54 #include <set>
  55 #include <time.h>
  56 #include "inspircd_config.h"
  57 #include "inspircd_version.h"
  58 #include "typedefs.h"
  59
  60 CoreExport extern InspIRCd* ServerInstance;
  61
  62 #include "caller.h"
  63 #include "cull_list.h"
  64 #include "extensible.h"
  65 #include "numerics.h"
  66 #include "uid.h"
  67 #include "users.h"
  68 #include "channels.h"
  69 #include "timer.h"
  70 #include "hashcomp.h"
  71 #include "logger.h"
  72 #include "usermanager.h"
  73 #include "socket.h"
  74 #include "ctables.h"
  75 #include "command_parse.h"
  76 #include "mode.h"
  77 #include "socketengine.h"
  78 #include "snomasks.h"
  79 #include "filelogger.h"
  80 #include "modules.h"
  81 #include "threadengine.h"
  82 #include "configreader.h"
  83 #include "inspstring.h"
  84 #include "protocol.h"
  85
  86 #ifndef PATH_MAX
  87 #warning Potentially broken system, PATH_MAX undefined
  88 #define PATH_MAX 4096
  89 #endif
  90
  91 /**
  92  * Used to define the maximum number of parameters a command may have.
  93  */
  94 #define MAXPARAMETERS 127
  95
  96 /** Returned by some functions to indicate failure.
  97  */
  98 #define ERROR -1
  99
 100 /** Support for librodent -
 101  * see http://www.chatspike.net/index.php?z=64
 102  */
 103 #define ETIREDHAMSTERS EAGAIN
 104
 105 /** Template function to convert any input type to std::string
 106  */
 107 template<typename T> inline std::string ConvNumeric(const T &in)
 108 {
 109         if (in == 0) return "0";
 110         char res[MAXBUF];
 111         char* out = res;
 112         T quotient = in;
 113         while (quotient) {
 114                 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
 115                 ++out;
 116                 quotient /= 10;
 117         }
 118         if (in < 0)
 119                 *out++ = '-';
 120         *out = 0;
 121         std::reverse(res,out);
 122         return res;
 123 }
 124
 125 /** Template function to convert any input type to std::string
 126  */
 127 inline std::string ConvToStr(const int in)
 128 {
 129         return ConvNumeric(in);
 130 }
 131
 132 /** Template function to convert any input type to std::string
 133  */
 134 inline std::string ConvToStr(const long in)
 135 {
 136         return ConvNumeric(in);
 137 }
 138
 139 /** Template function to convert any input type to std::string
 140  */
 141 inline std::string ConvToStr(const char* in)
 142 {
 143         return in;
 144 }
 145
 146 /** Template function to convert any input type to std::string
 147  */
 148 inline std::string ConvToStr(const bool in)
 149 {
 150         return (in ? "1" : "0");
 151 }
 152
 153 /** Template function to convert any input type to std::string
 154  */
 155 inline std::string ConvToStr(char in)
 156 {
 157         return std::string(in,1);
 158 }
 159
 160 /** Template function to convert any input type to std::string
 161  */
 162 template <class T> inline std::string ConvToStr(const T &in)
 163 {
 164         std::stringstream tmp;
 165         if (!(tmp << in)) return std::string();
 166         return tmp.str();
 167 }
 168
 169 /** Template function to convert any input type to any other type
 170  * (usually an integer or numeric type)
 171  */
 172 template<typename T> inline long ConvToInt(const T &in)
 173 {
 174         std::stringstream tmp;
 175         if (!(tmp << in)) return 0;
 176         return atol(tmp.str().c_str());
 177 }
 178
 179 /** This class contains various STATS counters
 180  * It is used by the InspIRCd class, which internally
 181  * has an instance of it.
 182  */
 183 class serverstats
 184 {
 185   public:
 186         /** Number of accepted connections
 187          */
 188         unsigned long statsAccept;
 189         /** Number of failed accepts
 190          */
 191         unsigned long statsRefused;
 192         /** Number of unknown commands seen
 193          */
 194         unsigned long statsUnknown;
 195         /** Number of nickname collisions handled
 196          */
 197         unsigned long statsCollisions;
 198         /** Number of DNS queries sent out
 199          */
 200         unsigned long statsDns;
 201         /** Number of good DNS replies received
 202          * NOTE: This may not tally to the number sent out,
 203          * due to timeouts and other latency issues.
 204          */
 205         unsigned long statsDnsGood;
 206         /** Number of bad (negative) DNS replies received
 207          * NOTE: This may not tally to the number sent out,
 208          * due to timeouts and other latency issues.
 209          */
 210         unsigned long statsDnsBad;
 211         /** Number of inbound connections seen
 212          */
 213         unsigned long statsConnects;
 214         /** Total bytes of data transmitted
 215          */
 216         unsigned long statsSent;
 217         /** Total bytes of data received
 218          */
 219         unsigned long statsRecv;
 220         /** Cpu usage at last sample
 221          */
 222         timeval LastCPU;
 223         /** Time last sample was read
 224          */
 225         timespec LastSampled;
 226         /** The constructor initializes all the counts to zero
 227          */
 228         serverstats()
 229                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
 230                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
 231         {
 232         }
 233 };
 234
 235 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
 236 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 237 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
 238 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
 239 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
 240 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
 241 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 242 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 243
 244 /** The main class of the irc server.
 245  * This class contains instances of all the other classes in this software.
 246  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 247  * object, and a list of active Module objects, and facilities for Module
 248  * objects to interact with the core system it implements.
 249  */
 250 class CoreExport InspIRCd
 251 {
 252  private:
 253         /** Holds the current UID. Used to generate the next one.
 254          */
 255         char current_uid[UUID_LENGTH];
 256
 257         /** Set up the signal handlers
 258          */
 259         void SetSignals();
 260
 261         /** Daemonize the ircd and close standard input/output streams
 262          * @return True if the program daemonized succesfully
 263          */
 264         bool DaemonSeed();
 265
 266         /** Iterate the list of BufferedSocket objects, removing ones which have timed out
 267          * @param TIME the current time
 268          */
 269         void DoSocketTimeouts(time_t TIME);
 270
 271         /** Increments the current UID by one.
 272          */
 273         void IncrementUID(int pos);
 274
 275         /** Perform background user events such as PING checks
 276          */
 277         void DoBackgroundUserStuff();
 278
 279         /** Returns true when all modules have done pre-registration checks on a user
 280          * @param user The user to verify
 281          * @return True if all modules have finished checking this user
 282          */
 283         bool AllModulesReportReady(LocalUser* user);
 284
 285         /** The current time, updated in the mainloop
 286          */
 287         struct timespec TIME;
 288
 289         /** A 64k buffer used to read socket data into
 290          * NOTE: update ValidateNetBufferSize if you change this
 291          */
 292         char ReadBuffer[65535];
 293
 294 #ifdef WIN32
 295         IPC* WindowsIPC;
 296 #endif
 297
 298  public:
 299
 300         /** Global cull list, will be processed on next iteration
 301          */
 302         CullList GlobalCulls;
 303         /** Actions that must happen outside of the current call stack */
 304         ActionList AtomicActions;
 305
 306         /**** Functors ****/
 307
 308         IsNickHandler HandleIsNick;
 309         IsIdentHandler HandleIsIdent;
 310         FloodQuitUserHandler HandleFloodQuitUser;
 311         OnCheckExemptionHandler HandleOnCheckExemption;
 312         IsChannelHandler HandleIsChannel;
 313         IsSIDHandler HandleIsSID;
 314         RehashHandler HandleRehash;
 315         GenRandomHandler HandleGenRandom;
 316
 317         /** 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
 318          * Reason for it:
 319          * kludge alert!
 320          * SendMode expects a User* to send the numeric replies
 321          * back to, so we create it a fake user that isnt in the user
 322          * hash and set its descriptor to FD_MAGIC_NUMBER so the data
 323          * falls into the abyss :p
 324          */
 325         FakeUser* FakeClient;
 326
 327         /** Returns the next available UID for this server.
 328          */
 329         std::string GetUID();
 330
 331         /** Find a user in the UUID hash
 332          * @param nick The nickname to find
 333          * @return A pointer to the user, or NULL if the user does not exist
 334          */
 335         User* FindUUID(const std::string &);
 336
 337         /** Find a user in the UUID hash
 338          * @param nick The nickname to find
 339          * @return A pointer to the user, or NULL if the user does not exist
 340          */
 341         User* FindUUID(const char *);
 342
 343         /** Build the ISUPPORT string by triggering all modules On005Numeric events
 344          */
 345         void BuildISupport();
 346
 347         /** Time this ircd was booted
 348          */
 349         time_t startup_time;
 350
 351         /** Config file pathname specified on the commandline or via ./configure
 352          */
 353         std::string ConfigFileName;
 354
 355         ExtensionManager Extensions;
 356
 357         /** Mode handler, handles mode setting and removal
 358          */
 359         ModeParser* Modes;
 360
 361         /** Command parser, handles client to server commands
 362          */
 363         CommandParser* Parser;
 364
 365         /** Socket engine, handles socket activity events
 366          */
 367         SocketEngine* SE;
 368
 369         /** Thread engine, Handles threading where required
 370          */
 371         ThreadEngine* Threads;
 372
 373         /** The thread/class used to read config files in REHASH and on startup
 374          */
 375         ConfigReaderThread* ConfigThread;
 376
 377         /** LogManager handles logging.
 378          */
 379         LogManager *Logs;
 380
 381         /** ModuleManager contains everything related to loading/unloading
 382          * modules.
 383          */
 384         ModuleManager* Modules;
 385
 386         /** BanCacheManager is used to speed up checking of restrictions on connection
 387          * to the IRCd.
 388          */
 389         BanCacheManager *BanCache;
 390
 391         /** Stats class, holds miscellaneous stats counters
 392          */
 393         serverstats* stats;
 394
 395         /**  Server Config class, holds configuration file data
 396          */
 397         ServerConfig* Config;
 398
 399         /** Snomask manager - handles routing of snomask messages
 400          * to opers.
 401          */
 402         SnomaskManager* SNO;
 403
 404         /** DNS class, provides resolver facilities to the core and modules
 405          */
 406         DNS* Res;
 407
 408         /** Timer manager class, triggers Timer timer events
 409          */
 410         TimerManager* Timers;
 411
 412         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 413          */
 414         XLineManager* XLines;
 415
 416         /** User manager. Various methods and data associated with users.
 417          */
 418         UserManager *Users;
 419
 420         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 421          */
 422         chan_hash* chanlist;
 423
 424         /** List of the open ports
 425          */
 426         std::vector<ListenSocket*> ports;
 427
 428         /** Set to the current signal recieved
 429          */
 430         int s_signal;
 431
 432         /** Protocol interface, overridden by server protocol modules
 433          */
 434         ProtocolInterface* PI;
 435
 436         /** Holds extensible for user nickforced
 437          */
 438         LocalIntExt NICKForced;
 439
 440         /** Holds extensible for user operquit
 441          */
 442         LocalStringExt OperQuit;
 443
 444         /** Get the current time
 445          * Because this only calls time() once every time around the mainloop,
 446          * it is much faster than calling time() directly.
 447          * @return The current time as an epoch value (time_t)
 448          */
 449         inline time_t Time() { return TIME.tv_sec; }
 450         /** The fractional time at the start of this mainloop iteration (nanoseconds) */
 451         inline long Time_ns() { return TIME.tv_nsec; }
 452         /** Update the current time. Don't call this unless you have reason to do so. */
 453         void UpdateTime();
 454
 455         /** Generate a random string with the given length
 456          * @param length The length in bytes
 457          * @param printable if false, the string will use characters 0-255; otherwise,
 458          * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
 459          */
 460         std::string GenRandomStr(int length, bool printable = true);
 461         /** Generate a random integer.
 462          * This is generally more secure than rand()
 463          */
 464         unsigned long GenRandomInt(unsigned long max);
 465
 466         /** Fill a buffer with random bits */
 467         caller2<void, char*, size_t> GenRandom;
 468
 469         /** Bind all ports specified in the configuration file.
 470          * @return The number of ports bound without error
 471          */
 472         int BindPorts(FailedPortList &failed_ports);
 473
 474         /** Binds a socket on an already open file descriptor
 475          * @param sockfd A valid file descriptor of an open socket
 476          * @param port The port number to bind to
 477          * @param addr The address to bind to (IP only)
 478          * @return True if the port was bound successfully
 479          */
 480         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
 481
 482         /** Gets the GECOS (description) field of the given server.
 483          * If the servername is not that of the local server, the name
 484          * is passed to handling modules which will attempt to determine
 485          * the GECOS that bleongs to the given servername.
 486          * @param servername The servername to find the description of
 487          * @return The description of this server, or of the local server
 488          */
 489         std::string GetServerDescription(const std::string& servername);
 490
 491         /** Find a user in the nick hash.
 492          * If the user cant be found in the nick hash check the uuid hash
 493          * @param nick The nickname to find
 494          * @return A pointer to the user, or NULL if the user does not exist
 495          */
 496         User* FindNick(const std::string &nick);
 497
 498         /** Find a user in the nick hash.
 499          * If the user cant be found in the nick hash check the uuid hash
 500          * @param nick The nickname to find
 501          * @return A pointer to the user, or NULL if the user does not exist
 502          */
 503         User* FindNick(const char* nick);
 504
 505         /** Find a user in the nick hash ONLY
 506          */
 507         User* FindNickOnly(const char* nick);
 508
 509         /** Find a user in the nick hash ONLY
 510          */
 511         User* FindNickOnly(const std::string &nick);
 512
 513         /** Find a channel in the channels hash
 514          * @param chan The channel to find
 515          * @return A pointer to the channel, or NULL if the channel does not exist
 516          */
 517         Channel* FindChan(const std::string &chan);
 518
 519         /** Find a channel in the channels hash
 520          * @param chan The channel to find
 521          * @return A pointer to the channel, or NULL if the channel does not exist
 522          */
 523         Channel* FindChan(const char* chan);
 524
 525         /** Check we aren't running as root, and exit if we are
 526          * @return Depending on the configuration, this function may never return
 527          */
 528         void CheckRoot();
 529
 530         /** Determine the right path for, and open, the logfile
 531          * @param argv The argv passed to main() initially, used to calculate program path
 532          * @param argc The argc passed to main() initially, used to calculate program path
 533          * @return True if the log could be opened, false if otherwise
 534          */
 535         bool OpenLog(char** argv, int argc);
 536
 537         /** Return true if a channel name is valid
 538          * @param chname A channel name to verify
 539          * @return True if the name is valid
 540          */
 541         caller2<bool, const char*, size_t> IsChannel;
 542
 543         /** Return true if str looks like a server ID
 544          * @param string to check against
 545          */
 546         caller1<bool, const std::string&> IsSID;
 547
 548         /** Rehash the local server
 549          */
 550         caller1<void, const std::string&> Rehash;
 551
 552         /** Handles incoming signals after being set
 553          * @param signal the signal recieved
 554          */
 555         void SignalHandler(int signal);
 556
 557         /** Sets the signal recieved
 558          * @param signal the signal recieved
 559          */
 560         static void SetSignal(int signal);
 561
 562         /** Causes the server to exit after unloading modules and
 563          * closing all open file descriptors.
 564          *
 565          * @param The exit code to give to the operating system
 566          * (See the ExitStatus enum for valid values)
 567          */
 568         void Exit(int status);
 569
 570         /** Causes the server to exit immediately with exit code 0.
 571          * The status code is required for signal handlers, and ignored.
 572          */
 573         static void QuickExit(int status);
 574
 575         /** Return a count of channels on the network
 576          * @return The number of channels
 577          */
 578         long ChannelCount();
 579
 580         /** Send an error notice to all local users, opered and unopered
 581          * @param s The error string to send
 582          */
 583         void SendError(const std::string &s);
 584
 585         /** Return true if a nickname is valid
 586          * @param n A nickname to verify
 587          * @return True if the nick is valid
 588          */
 589         caller2<bool, const char*, size_t> IsNick;
 590
 591         /** Return true if an ident is valid
 592          * @param An ident to verify
 593          * @return True if the ident is valid
 594          */
 595         caller1<bool, const char*> IsIdent;
 596
 597         /** Add a dns Resolver class to this server's active set
 598          * @param r The resolver to add
 599          * @param cached If this value is true, then the cache will
 600          * be searched for the DNS result, immediately. If the value is
 601          * false, then a request will be sent to the nameserver, and the
 602          * result will not be immediately available. You should usually
 603          * use the boolean value which you passed to the Resolver
 604          * constructor, which Resolver will set appropriately depending
 605          * on if cached results are available and haven't expired. It is
 606          * however safe to force this value to false, forcing a remote DNS
 607          * lookup, but not an update of the cache.
 608          * @return True if the operation completed successfully. Note that
 609          * if this method returns true, you should not attempt to access
 610          * the resolver class you pass it after this call, as depending upon
 611          * the request given, the object may be deleted!
 612          */
 613         bool AddResolver(Resolver* r, bool cached);
 614
 615         /** Add a command to this server's command parser
 616          * @param f A Command command handler object to add
 617          * @throw ModuleException Will throw ModuleExcption if the command already exists
 618          */
 619         inline void AddCommand(Command *f)
 620         {
 621                 Modules->AddService(*f);
 622         }
 623
 624         /** Send a modechange.
 625          * The parameters provided are identical to that sent to the
 626          * handler for class cmd_mode.
 627          * @param parameters The mode parameters
 628          * @param user The user to send error messages to
 629          */
 630         void SendMode(const std::vector<std::string>& parameters, User *user);
 631
 632         /** Send a modechange and route it to the network.
 633          * The parameters provided are identical to that sent to the
 634          * handler for class cmd_mode.
 635          * @param parameters The mode parameters
 636          * @param user The user to send error messages to
 637          */
 638         void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
 639
 640         /** Match two strings using pattern matching, optionally, with a map
 641          * to check case against (may be NULL). If map is null, match will be case insensitive.
 642          * @param str The literal string to match against
 643          * @param mask The glob pattern to match against.
 644          */
 645         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 646         static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
 647
 648         /** Match two strings using pattern matching, optionally, with a map
 649          * to check case against (may be NULL). If map is null, match will be case insensitive.
 650          * Supports CIDR patterns as well as globs.
 651          * @param str The literal string to match against
 652          * @param mask The glob or CIDR pattern to match against.
 653          */
 654         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 655         static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
 656
 657         /** Call the handler for a given command.
 658          * @param commandname The command whos handler you wish to call
 659          * @param parameters The mode parameters
 660          * @param pcnt The number of items you have given in the first parameter
 661          * @param user The user to execute the command as
 662          * @return True if the command handler was called successfully
 663          */
 664         CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
 665
 666         /** Return true if the command is a module-implemented command and the given parameters are valid for it
 667          * @param parameters The mode parameters
 668          * @param pcnt The number of items you have given in the first parameter
 669          * @param user The user to test-execute the command as
 670          * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
 671          */
 672         bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
 673
 674         /** Return true if the given parameter is a valid nick!user\@host mask
 675          * @param mask A nick!user\@host masak to match against
 676          * @return True i the mask is valid
 677          */
 678         bool IsValidMask(const std::string &mask);
 679
 680         /** Rehash the local server
 681          */
 682         void RehashServer();
 683
 684         /** Check if the given nickmask matches too many users, send errors to the given user
 685          * @param nick A nickmask to match against
 686          * @param user A user to send error text to
 687          * @return True if the nick matches too many users
 688          */
 689         bool NickMatchesEveryone(const std::string &nick, User* user);
 690
 691         /** Check if the given IP mask matches too many users, send errors to the given user
 692          * @param ip An ipmask to match against
 693          * @param user A user to send error text to
 694          * @return True if the ip matches too many users
 695          */
 696         bool IPMatchesEveryone(const std::string &ip, User* user);
 697
 698         /** Check if the given hostmask matches too many users, send errors to the given user
 699          * @param mask A hostmask to match against
 700          * @param user A user to send error text to
 701          * @return True if the host matches too many users
 702          */
 703         bool HostMatchesEveryone(const std::string &mask, User* user);
 704
 705         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 706          * @param str A string containing a time in the form 1y2w3d4h6m5s
 707          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 708          * @return The total number of seconds
 709          */
 710         long Duration(const std::string &str);
 711
 712         /** Attempt to compare a password to a string from the config file.
 713          * This will be passed to handling modules which will compare the data
 714          * against possible hashed equivalents in the input string.
 715          * @param ex The object (user, server, whatever) causing the comparison.
 716          * @param data The data from the config file
 717          * @param input The data input by the oper
 718          * @param hashtype The hash from the config file
 719          * @return 0 if the strings match, 1 or -1 if they do not
 720          */
 721         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 722
 723         /** Check if a given server is a uline.
 724          * An empty string returns true, this is by design.
 725          * @param server The server to check for uline status
 726          * @return True if the server is a uline OR the string is empty
 727          */
 728         bool ULine(const std::string& server);
 729
 730         /** Returns true if the uline is 'silent' (doesnt generate
 731          * remote connect notices etc).
 732          */
 733         bool SilentULine(const std::string& server);
 734
 735         /** Returns the full version string of this ircd
 736          * @return The version string
 737          */
 738         std::string GetVersionString(bool rawversion = false);
 739
 740         /** Attempt to write the process id to a given file
 741          * @param filename The PID file to attempt to write to
 742          * @return This function may bail if the file cannot be written
 743          */
 744         void WritePID(const std::string &filename);
 745
 746         /** This constructor initialises all the subsystems and reads the config file.
 747          * @param argc The argument count passed to main()
 748          * @param argv The argument list passed to main()
 749          * @throw <anything> If anything is thrown from here and makes it to
 750          * you, you should probably just give up and go home. Yes, really.
 751          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 752          */
 753         InspIRCd(int argc, char** argv);
 754
 755         /** Send a line of WHOIS data to a user.
 756          * @param user user to send the line to
 757          * @param dest user being WHOISed
 758          * @param numeric Numeric to send
 759          * @param text Text of the numeric
 760          */
 761         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 762
 763         /** Send a line of WHOIS data to a user.
 764          * @param user user to send the line to
 765          * @param dest user being WHOISed
 766          * @param numeric Numeric to send
 767          * @param format Format string for the numeric
 768          * @param ... Parameters for the format string
 769          */
 770         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 771
 772         /** Handle /STATS
 773          */
 774         void DoStats(char statschar, User* user, string_list &results);
 775
 776         /** Handle /WHOIS
 777          */
 778         void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
 779
 780         /** Quit a user for excess flood, and if they are not
 781          * fully registered yet, temporarily zline their IP.
 782          * @param current user to quit
 783          */
 784         caller1<void, User*> FloodQuitUser;
 785
 786         /** Called to check whether a channel restriction mode applies to a user
 787          * @param User that is attempting some action
 788          * @param Channel that the action is being performed on
 789          * @param Action name
 790          */
 791         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 792
 793         /** Restart the server.
 794          * This function will not return. If an error occurs,
 795          * it will throw an instance of CoreException.
 796          * @param reason The restart reason to show to all clients
 797          * @throw CoreException An instance of CoreException indicating the error from execv().
 798          */
 799         void Restart(const std::string &reason);
 800
 801         /** Prepare the ircd for restart or shutdown.
 802          * This function unloads all modules which can be unloaded,
 803          * closes all open sockets, and closes the logfile.
 804          */
 805         void Cleanup();
 806
 807         /** This copies the user and channel hash_maps into new hash maps.
 808          * This frees memory used by the hash_map allocator (which it neglects
 809          * to free, most of the time, using tons of ram)
 810          */
 811         void RehashUsersAndChans();
 812
 813         /** Resets the cached max bans value on all channels.
 814          * Called by rehash.
 815          */
 816         void ResetMaxBans();
 817
 818         /** Return a time_t as a human-readable string.
 819          */
 820         std::string TimeString(time_t curtime);
 821
 822         /** Begin execution of the server.
 823          * NOTE: this function NEVER returns. Internally,
 824          * it will repeatedly loop.
 825          * @return The return value for this function is undefined.
 826          */
 827         int Run();
 828
 829         /** Adds an extban char to the 005 token.
 830          */
 831         void AddExtBanChar(char c);
 832
 833         char* GetReadBuffer()
 834         {
 835                 return this->ReadBuffer;
 836         }
 837 };
 838
 839 ENTRYPOINT;
 840
 841 template<class Cmd>
 842 class CommandModule : public Module
 843 {
 844         Cmd cmd;
 845  public:
 846         CommandModule() : cmd(this)
 847         {
 848         }
 849
 850         void init()
 851         {
 852                 ServerInstance->Modules->AddService(cmd);
 853         }
 854
 855         Version GetVersion()
 856         {
 857                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 858         }
 859 };
 860
 861 #endif