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 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 "inspircd_config.h"
  56 #include "inspircd_version.h"
  57 #include "typedefs.h"
  58
  59 CoreExport extern InspIRCd* ServerInstance;
  60
  61 #include "caller.h"
  62 #include "cull_list.h"
  63 #include "extensible.h"
  64 #include "numerics.h"
  65 #include "uid.h"
  66 #include "users.h"
  67 #include "channels.h"
  68 #include "timer.h"
  69 #include "hashcomp.h"
  70 #include "logger.h"
  71 #include "usermanager.h"
  72 #include "socket.h"
  73 #include "ctables.h"
  74 #include "command_parse.h"
  75 #include "mode.h"
  76 #include "socketengine.h"
  77 #include "snomasks.h"
  78 #include "filelogger.h"
  79 #include "caller.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         double statsSent;
 217         /** Total bytes of data received
 218          */
 219         double statsRecv;
 220         /** Cpu usage at last sample
 221          */
 222         timeval LastCPU;
 223         /** Time last sample was read
 224          */
 225         timeval 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.0), statsRecv(0.0)
 231         {
 232         }
 233 };
 234
 235 DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
 236 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
 237 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
 238 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
 239 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
 240 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 241
 242 /** The main class of the irc server.
 243  * This class contains instances of all the other classes in this software.
 244  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 245  * object, and a list of active Module objects, and facilities for Module
 246  * objects to interact with the core system it implements.
 247  */
 248 class CoreExport InspIRCd
 249 {
 250  private:
 251         /** Holds the current UID. Used to generate the next one.
 252          */
 253         char current_uid[UUID_LENGTH];
 254
 255         /** Set up the signal handlers
 256          */
 257         void SetSignals();
 258
 259         /** Daemonize the ircd and close standard input/output streams
 260          * @return True if the program daemonized succesfully
 261          */
 262         bool DaemonSeed();
 263
 264         /** Iterate the list of BufferedSocket objects, removing ones which have timed out
 265          * @param TIME the current time
 266          */
 267         void DoSocketTimeouts(time_t TIME);
 268
 269         /** Increments the current UID by one.
 270          */
 271         void IncrementUID(int pos);
 272
 273         /** Perform background user events such as PING checks
 274          */
 275         void DoBackgroundUserStuff();
 276
 277         /** Returns true when all modules have done pre-registration checks on a user
 278          * @param user The user to verify
 279          * @return True if all modules have finished checking this user
 280          */
 281         bool AllModulesReportReady(LocalUser* user);
 282
 283         /** The current time, updated in the mainloop
 284          */
 285         time_t TIME;
 286
 287         /** The time that was recorded last time around the mainloop
 288          */
 289         time_t OLDTIME;
 290
 291         /** A 64k buffer used to read socket data into
 292          * NOTE: update ValidateNetBufferSize if you change this
 293          */
 294         char ReadBuffer[65535];
 295
 296 #ifdef WIN32
 297         IPC* WindowsIPC;
 298 #endif
 299
 300  public:
 301
 302         /** Global cull list, will be processed on next iteration
 303          */
 304         CullList GlobalCulls;
 305         /** Actions that must happen outside of the current call stack */
 306         ActionList AtomicActions;
 307
 308         /**** Functors ****/
 309
 310         IsNickHandler HandleIsNick;
 311         IsIdentHandler HandleIsIdent;
 312         FloodQuitUserHandler HandleFloodQuitUser;
 313         IsChannelHandler HandleIsChannel;
 314         IsSIDHandler HandleIsSID;
 315         RehashHandler HandleRehash;
 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         time_t Time();
 450
 451         /** Bind all ports specified in the configuration file.
 452          * @return The number of ports bound without error
 453          */
 454         int BindPorts(FailedPortList &failed_ports);
 455
 456         /** Binds a socket on an already open file descriptor
 457          * @param sockfd A valid file descriptor of an open socket
 458          * @param port The port number to bind to
 459          * @param addr The address to bind to (IP only)
 460          * @return True if the port was bound successfully
 461          */
 462         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
 463
 464         /** Gets the GECOS (description) field of the given server.
 465          * If the servername is not that of the local server, the name
 466          * is passed to handling modules which will attempt to determine
 467          * the GECOS that bleongs to the given servername.
 468          * @param servername The servername to find the description of
 469          * @return The description of this server, or of the local server
 470          */
 471         std::string GetServerDescription(const std::string& servername);
 472
 473         /** Find a user in the nick hash.
 474          * If the user cant be found in the nick hash check the uuid hash
 475          * @param nick The nickname to find
 476          * @return A pointer to the user, or NULL if the user does not exist
 477          */
 478         User* FindNick(const std::string &nick);
 479
 480         /** Find a user in the nick hash.
 481          * If the user cant be found in the nick hash check the uuid hash
 482          * @param nick The nickname to find
 483          * @return A pointer to the user, or NULL if the user does not exist
 484          */
 485         User* FindNick(const char* nick);
 486
 487         /** Find a user in the nick hash ONLY
 488          */
 489         User* FindNickOnly(const char* nick);
 490
 491         /** Find a user in the nick hash ONLY
 492          */
 493         User* FindNickOnly(const std::string &nick);
 494
 495         /** Find a channel in the channels hash
 496          * @param chan The channel to find
 497          * @return A pointer to the channel, or NULL if the channel does not exist
 498          */
 499         Channel* FindChan(const std::string &chan);
 500
 501         /** Find a channel in the channels hash
 502          * @param chan The channel to find
 503          * @return A pointer to the channel, or NULL if the channel does not exist
 504          */
 505         Channel* FindChan(const char* chan);
 506
 507         /** Check we aren't running as root, and exit if we are
 508          * @return Depending on the configuration, this function may never return
 509          */
 510         void CheckRoot();
 511
 512         /** Determine the right path for, and open, the logfile
 513          * @param argv The argv passed to main() initially, used to calculate program path
 514          * @param argc The argc passed to main() initially, used to calculate program path
 515          * @return True if the log could be opened, false if otherwise
 516          */
 517         bool OpenLog(char** argv, int argc);
 518
 519         /** Return true if a channel name is valid
 520          * @param chname A channel name to verify
 521          * @return True if the name is valid
 522          */
 523         caller2<bool, const char*, size_t> IsChannel;
 524
 525         /** Return true if str looks like a server ID
 526          * @param string to check against
 527          */
 528         caller1<bool, const std::string&> IsSID;
 529
 530         /** Rehash the local server
 531          */
 532         caller1<void, const std::string&> Rehash;
 533
 534         /** Handles incoming signals after being set
 535          * @param signal the signal recieved
 536          */
 537         void SignalHandler(int signal);
 538
 539         /** Sets the signal recieved
 540          * @param signal the signal recieved
 541          */
 542         static void SetSignal(int signal);
 543
 544         /** Causes the server to exit after unloading modules and
 545          * closing all open file descriptors.
 546          *
 547          * @param The exit code to give to the operating system
 548          * (See the ExitStatus enum for valid values)
 549          */
 550         void Exit(int status);
 551
 552         /** Causes the server to exit immediately with exit code 0.
 553          * The status code is required for signal handlers, and ignored.
 554          */
 555         static void QuickExit(int status);
 556
 557         /** Return a count of channels on the network
 558          * @return The number of channels
 559          */
 560         long ChannelCount();
 561
 562         /** Send an error notice to all local users, opered and unopered
 563          * @param s The error string to send
 564          */
 565         void SendError(const std::string &s);
 566
 567         /** Return true if a nickname is valid
 568          * @param n A nickname to verify
 569          * @return True if the nick is valid
 570          */
 571         caller2<bool, const char*, size_t> IsNick;
 572
 573         /** Return true if an ident is valid
 574          * @param An ident to verify
 575          * @return True if the ident is valid
 576          */
 577         caller1<bool, const char*> IsIdent;
 578
 579         /** Add a dns Resolver class to this server's active set
 580          * @param r The resolver to add
 581          * @param cached If this value is true, then the cache will
 582          * be searched for the DNS result, immediately. If the value is
 583          * false, then a request will be sent to the nameserver, and the
 584          * result will not be immediately available. You should usually
 585          * use the boolean value which you passed to the Resolver
 586          * constructor, which Resolver will set appropriately depending
 587          * on if cached results are available and haven't expired. It is
 588          * however safe to force this value to false, forcing a remote DNS
 589          * lookup, but not an update of the cache.
 590          * @return True if the operation completed successfully. Note that
 591          * if this method returns true, you should not attempt to access
 592          * the resolver class you pass it after this call, as depending upon
 593          * the request given, the object may be deleted!
 594          */
 595         bool AddResolver(Resolver* r, bool cached);
 596
 597         /** Add a command to this server's command parser
 598          * @param f A Command command handler object to add
 599          * @throw ModuleException Will throw ModuleExcption if the command already exists
 600          */
 601         void AddCommand(Command *f);
 602
 603         /** Send a modechange.
 604          * The parameters provided are identical to that sent to the
 605          * handler for class cmd_mode.
 606          * @param parameters The mode parameters
 607          * @param user The user to send error messages to
 608          */
 609         void SendMode(const std::vector<std::string>& parameters, User *user);
 610
 611         /** Match two strings using pattern matching, optionally, with a map
 612          * to check case against (may be NULL). If map is null, match will be case insensitive.
 613          * @param str The literal string to match against
 614          * @param mask The glob pattern to match against.
 615          */
 616         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 617         static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
 618
 619         /** Match two strings using pattern matching, optionally, with a map
 620          * to check case against (may be NULL). If map is null, match will be case insensitive.
 621          * Supports CIDR patterns as well as globs.
 622          * @param str The literal string to match against
 623          * @param mask The glob or CIDR pattern to match against.
 624          */
 625         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 626         static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
 627
 628         /** Call the handler for a given command.
 629          * @param commandname The command whos handler you wish to call
 630          * @param parameters The mode parameters
 631          * @param pcnt The number of items you have given in the first parameter
 632          * @param user The user to execute the command as
 633          * @return True if the command handler was called successfully
 634          */
 635         CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
 636
 637         /** Return true if the command is a module-implemented command and the given parameters are valid for it
 638          * @param parameters The mode parameters
 639          * @param pcnt The number of items you have given in the first parameter
 640          * @param user The user to test-execute the command as
 641          * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
 642          */
 643         bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
 644
 645         /** Return true if the given parameter is a valid nick!user\@host mask
 646          * @param mask A nick!user\@host masak to match against
 647          * @return True i the mask is valid
 648          */
 649         bool IsValidMask(const std::string &mask);
 650
 651         /** Rehash the local server
 652          */
 653         void RehashServer();
 654
 655         /** Check if the given nickmask matches too many users, send errors to the given user
 656          * @param nick A nickmask to match against
 657          * @param user A user to send error text to
 658          * @return True if the nick matches too many users
 659          */
 660         bool NickMatchesEveryone(const std::string &nick, User* user);
 661
 662         /** Check if the given IP mask matches too many users, send errors to the given user
 663          * @param ip An ipmask to match against
 664          * @param user A user to send error text to
 665          * @return True if the ip matches too many users
 666          */
 667         bool IPMatchesEveryone(const std::string &ip, User* user);
 668
 669         /** Check if the given hostmask matches too many users, send errors to the given user
 670          * @param mask A hostmask to match against
 671          * @param user A user to send error text to
 672          * @return True if the host matches too many users
 673          */
 674         bool HostMatchesEveryone(const std::string &mask, User* user);
 675
 676         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 677          * @param str A string containing a time in the form 1y2w3d4h6m5s
 678          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 679          * @return The total number of seconds
 680          */
 681         long Duration(const std::string &str);
 682
 683         /** Attempt to compare a password to a string from the config file.
 684          * This will be passed to handling modules which will compare the data
 685          * against possible hashed equivalents in the input string.
 686          * @param ex The object (user, server, whatever) causing the comparison.
 687          * @param data The data from the config file
 688          * @param input The data input by the oper
 689          * @param hashtype The hash from the config file
 690          * @return 0 if the strings match, 1 or -1 if they do not
 691          */
 692         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 693
 694         /** Check if a given server is a uline.
 695          * An empty string returns true, this is by design.
 696          * @param server The server to check for uline status
 697          * @return True if the server is a uline OR the string is empty
 698          */
 699         bool ULine(const std::string& server);
 700
 701         /** Returns true if the uline is 'silent' (doesnt generate
 702          * remote connect notices etc).
 703          */
 704         bool SilentULine(const std::string& server);
 705
 706         /** Returns the full version string of this ircd
 707          * @return The version string
 708          */
 709         std::string GetVersionString();
 710
 711         /** Attempt to write the process id to a given file
 712          * @param filename The PID file to attempt to write to
 713          * @return This function may bail if the file cannot be written
 714          */
 715         void WritePID(const std::string &filename);
 716
 717         /** This constructor initialises all the subsystems and reads the config file.
 718          * @param argc The argument count passed to main()
 719          * @param argv The argument list passed to main()
 720          * @throw <anything> If anything is thrown from here and makes it to
 721          * you, you should probably just give up and go home. Yes, really.
 722          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 723          */
 724         InspIRCd(int argc, char** argv);
 725
 726         /** Send a line of WHOIS data to a user.
 727          * @param user user to send the line to
 728          * @param dest user being WHOISed
 729          * @param numeric Numeric to send
 730          * @param text Text of the numeric
 731          */
 732         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 733
 734         /** Send a line of WHOIS data to a user.
 735          * @param user user to send the line to
 736          * @param dest user being WHOISed
 737          * @param numeric Numeric to send
 738          * @param format Format string for the numeric
 739          * @param ... Parameters for the format string
 740          */
 741         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 742
 743         /** Handle /STATS
 744          */
 745         void DoStats(char statschar, User* user, string_list &results);
 746
 747         /** Handle /WHOIS
 748          */
 749         void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
 750
 751         /** Quit a user for excess flood, and if they are not
 752          * fully registered yet, temporarily zline their IP.
 753          * @param current user to quit
 754          */
 755         caller1<void, User*> FloodQuitUser;
 756
 757         /** Restart the server.
 758          * This function will not return. If an error occurs,
 759          * it will throw an instance of CoreException.
 760          * @param reason The restart reason to show to all clients
 761          * @throw CoreException An instance of CoreException indicating the error from execv().
 762          */
 763         void Restart(const std::string &reason);
 764
 765         /** Prepare the ircd for restart or shutdown.
 766          * This function unloads all modules which can be unloaded,
 767          * closes all open sockets, and closes the logfile.
 768          */
 769         void Cleanup();
 770
 771         /** This copies the user and channel hash_maps into new hash maps.
 772          * This frees memory used by the hash_map allocator (which it neglects
 773          * to free, most of the time, using tons of ram)
 774          */
 775         void RehashUsersAndChans();
 776
 777         /** Resets the cached max bans value on all channels.
 778          * Called by rehash.
 779          */
 780         void ResetMaxBans();
 781
 782         /** Return a time_t as a human-readable string.
 783          */
 784         std::string TimeString(time_t curtime);
 785
 786         /** Begin execution of the server.
 787          * NOTE: this function NEVER returns. Internally,
 788          * it will repeatedly loop.
 789          * @return The return value for this function is undefined.
 790          */
 791         int Run();
 792
 793         /** Adds an extban char to the 005 token.
 794          */
 795         void AddExtBanChar(char c);
 796
 797         char* GetReadBuffer()
 798         {
 799                 return this->ReadBuffer;
 800         }
 801 };
 802
 803 ENTRYPOINT;
 804
 805 template<class Cmd>
 806 class CommandModule : public Module
 807 {
 808         Cmd cmd;
 809  public:
 810         CommandModule() : cmd(this)
 811         {
 812                 ServerInstance->AddCommand(&cmd);
 813         }
 814
 815         Version GetVersion()
 816         {
 817                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 818         }
 819 };
 820
 821 #endif