include/inspircd.h

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