include/inspircd.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
   7  *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *   Copyright (C) 2003 randomdan <???@???>
  11  *
  12  * This file is part of InspIRCd.  InspIRCd is free software: you can
  13  * redistribute it and/or modify it under the terms of the GNU General Public
  14  * License as published by the Free Software Foundation, version 2.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25
  26 #pragma once
  27
  28 #include <climits>
  29 #include <cmath>
  30 #include <csignal>
  31 #include <cstdarg>
  32 #include <cstdio>
  33 #include <cstring>
  34 #include <ctime>
  35
  36 #include <algorithm>
  37 #include <bitset>
  38 #include <deque>
  39 #include <list>
  40 #include <map>
  41 #include <set>
  42 #include <sstream>
  43 #include <string>
  44 #include <vector>
  45
  46 #include "compat.h"
  47 #include "typedefs.h"
  48
  49 CoreExport extern InspIRCd* ServerInstance;
  50
  51 #include "config.h"
  52 #include "consolecolors.h"
  53 #include "caller.h"
  54 #include "cull_list.h"
  55 #include "extensible.h"
  56 #include "numerics.h"
  57 #include "uid.h"
  58 #include "users.h"
  59 #include "channels.h"
  60 #include "timer.h"
  61 #include "hashcomp.h"
  62 #include "logger.h"
  63 #include "usermanager.h"
  64 #include "socket.h"
  65 #include "ctables.h"
  66 #include "command_parse.h"
  67 #include "mode.h"
  68 #include "socketengine.h"
  69 #include "snomasks.h"
  70 #include "filelogger.h"
  71 #include "modules.h"
  72 #include "threadengine.h"
  73 #include "configreader.h"
  74 #include "inspstring.h"
  75 #include "protocol.h"
  76
  77 /**
  78  * Used to define the maximum number of parameters a command may have.
  79  */
  80 #define MAXPARAMETERS 127
  81
  82 /** Returned by some functions to indicate failure.
  83  */
  84 #define ERROR -1
  85
  86 /** Template function to convert any input type to std::string
  87  */
  88 template<typename T> inline std::string ConvNumeric(const T &in)
  89 {
  90         if (in == 0) return "0";
  91         char res[MAXBUF];
  92         char* out = res;
  93         T quotient = in;
  94         while (quotient) {
  95                 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
  96                 ++out;
  97                 quotient /= 10;
  98         }
  99         if (in < 0)
 100                 *out++ = '-';
 101         *out = 0;
 102         std::reverse(res,out);
 103         return res;
 104 }
 105
 106 /** Template function to convert any input type to std::string
 107  */
 108 inline std::string ConvToStr(const int in)
 109 {
 110         return ConvNumeric(in);
 111 }
 112
 113 /** Template function to convert any input type to std::string
 114  */
 115 inline std::string ConvToStr(const long in)
 116 {
 117         return ConvNumeric(in);
 118 }
 119
 120 /** Template function to convert any input type to std::string
 121  */
 122 inline std::string ConvToStr(const char* in)
 123 {
 124         return in;
 125 }
 126
 127 /** Template function to convert any input type to std::string
 128  */
 129 inline std::string ConvToStr(const bool in)
 130 {
 131         return (in ? "1" : "0");
 132 }
 133
 134 /** Template function to convert any input type to std::string
 135  */
 136 inline std::string ConvToStr(char in)
 137 {
 138         return std::string(in,1);
 139 }
 140
 141 /** Template function to convert any input type to std::string
 142  */
 143 template <class T> inline std::string ConvToStr(const T &in)
 144 {
 145         std::stringstream tmp;
 146         if (!(tmp << in)) return std::string();
 147         return tmp.str();
 148 }
 149
 150 /** Template function to convert any input type to any other type
 151  * (usually an integer or numeric type)
 152  */
 153 template<typename T> inline long ConvToInt(const T &in)
 154 {
 155         std::stringstream tmp;
 156         if (!(tmp << in)) return 0;
 157         return atol(tmp.str().c_str());
 158 }
 159
 160 /** This class contains various STATS counters
 161  * It is used by the InspIRCd class, which internally
 162  * has an instance of it.
 163  */
 164 class serverstats
 165 {
 166   public:
 167         /** Number of accepted connections
 168          */
 169         unsigned long statsAccept;
 170         /** Number of failed accepts
 171          */
 172         unsigned long statsRefused;
 173         /** Number of unknown commands seen
 174          */
 175         unsigned long statsUnknown;
 176         /** Number of nickname collisions handled
 177          */
 178         unsigned long statsCollisions;
 179         /** Number of DNS queries sent out
 180          */
 181         unsigned long statsDns;
 182         /** Number of good DNS replies received
 183          * NOTE: This may not tally to the number sent out,
 184          * due to timeouts and other latency issues.
 185          */
 186         unsigned long statsDnsGood;
 187         /** Number of bad (negative) DNS replies received
 188          * NOTE: This may not tally to the number sent out,
 189          * due to timeouts and other latency issues.
 190          */
 191         unsigned long statsDnsBad;
 192         /** Number of inbound connections seen
 193          */
 194         unsigned long statsConnects;
 195         /** Total bytes of data transmitted
 196          */
 197         unsigned long statsSent;
 198         /** Total bytes of data received
 199          */
 200         unsigned long statsRecv;
 201 #ifdef _WIN32
 202         /** Cpu usage at last sample
 203         */
 204         FILETIME LastCPU;
 205         /** Time QP sample was read
 206         */
 207         LARGE_INTEGER LastSampled;
 208         /** QP frequency
 209         */
 210         LARGE_INTEGER QPFrequency;
 211 #else
 212         /** Cpu usage at last sample
 213          */
 214         timeval LastCPU;
 215         /** Time last sample was read
 216          */
 217         timespec LastSampled;
 218 #endif
 219         /** The constructor initializes all the counts to zero
 220          */
 221         serverstats()
 222                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
 223                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
 224         {
 225         }
 226 };
 227
 228 /** This class manages the generation and transmission of ISUPPORT. */
 229 class CoreExport ISupportManager
 230 {
 231 private:
 232         /** The generated lines which are sent to clients. */
 233         std::vector<std::string> Lines;
 234
 235 public:
 236         /** (Re)build the ISUPPORT vector. */
 237         void Build();
 238
 239         /** Returns the std::vector of ISUPPORT lines. */
 240         const std::vector<std::string>& GetLines()
 241         {
 242                 return this->Lines;
 243         }
 244
 245         /** Send the 005 numerics (ISUPPORT) to a user. */
 246         void SendTo(LocalUser* user);
 247 };
 248
 249 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
 250 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 251 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
 252 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
 253 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 254 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 255
 256 /** The main class of the irc server.
 257  * This class contains instances of all the other classes in this software.
 258  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 259  * object, and a list of active Module objects, and facilities for Module
 260  * objects to interact with the core system it implements.
 261  */
 262 class CoreExport InspIRCd
 263 {
 264  private:
 265         /** Set up the signal handlers
 266          */
 267         void SetSignals();
 268
 269         /** Daemonize the ircd and close standard input/output streams
 270          * @return True if the program daemonized succesfully
 271          */
 272         bool DaemonSeed();
 273
 274         /** Iterate the list of BufferedSocket objects, removing ones which have timed out
 275          * @param TIME the current time
 276          */
 277         void DoSocketTimeouts(time_t TIME);
 278
 279         /** Perform background user events such as PING checks
 280          */
 281         void DoBackgroundUserStuff();
 282
 283         /** Returns true when all modules have done pre-registration checks on a user
 284          * @param user The user to verify
 285          * @return True if all modules have finished checking this user
 286          */
 287         bool AllModulesReportReady(LocalUser* user);
 288
 289         /** The current time, updated in the mainloop
 290          */
 291         struct timespec TIME;
 292
 293         /** A 64k buffer used to read socket data into
 294          * NOTE: update ValidateNetBufferSize if you change this
 295          */
 296         char ReadBuffer[65535];
 297
 298  public:
 299
 300         UIDGenerator UIDGen;
 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         OnCheckExemptionHandler HandleOnCheckExemption;
 313         IsChannelHandler HandleIsChannel;
 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         /** Find a user in the UUID hash
 328          * @param uid The UUID to find
 329          * @return A pointer to the user, or NULL if the user does not exist
 330          */
 331         User* FindUUID(const std::string &uid);
 332
 333         /** Time this ircd was booted
 334          */
 335         time_t startup_time;
 336
 337         /** Config file pathname specified on the commandline or via ./configure
 338          */
 339         std::string ConfigFileName;
 340
 341         ExtensionManager Extensions;
 342
 343         /** Mode handler, handles mode setting and removal
 344          */
 345         ModeParser* Modes;
 346
 347         /** Command parser, handles client to server commands
 348          */
 349         CommandParser* Parser;
 350
 351         /** Socket engine, handles socket activity events
 352          */
 353         SocketEngine* SE;
 354
 355         /** Thread engine, Handles threading where required
 356          */
 357         ThreadEngine* Threads;
 358
 359         /** The thread/class used to read config files in REHASH and on startup
 360          */
 361         ConfigReaderThread* ConfigThread;
 362
 363         /** LogManager handles logging.
 364          */
 365         LogManager *Logs;
 366
 367         /** ModuleManager contains everything related to loading/unloading
 368          * modules.
 369          */
 370         ModuleManager* Modules;
 371
 372         /** BanCacheManager is used to speed up checking of restrictions on connection
 373          * to the IRCd.
 374          */
 375         BanCacheManager *BanCache;
 376
 377         /** Stats class, holds miscellaneous stats counters
 378          */
 379         serverstats* stats;
 380
 381         /**  Server Config class, holds configuration file data
 382          */
 383         ServerConfig* Config;
 384
 385         /** Snomask manager - handles routing of snomask messages
 386          * to opers.
 387          */
 388         SnomaskManager* SNO;
 389
 390         /** Timer manager class, triggers Timer timer events
 391          */
 392         TimerManager* Timers;
 393
 394         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 395          */
 396         XLineManager* XLines;
 397
 398         /** User manager. Various methods and data associated with users.
 399          */
 400         UserManager *Users;
 401
 402         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 403          */
 404         chan_hash* chanlist;
 405
 406         /** List of the open ports
 407          */
 408         std::vector<ListenSocket*> ports;
 409
 410         /** Set to the current signal recieved
 411          */
 412         static sig_atomic_t s_signal;
 413
 414         /** Protocol interface, overridden by server protocol modules
 415          */
 416         ProtocolInterface* PI;
 417
 418         /** Holds extensible for user operquit
 419          */
 420         LocalStringExt OperQuit;
 421
 422         /** Manages the generation and transmission of ISUPPORT. */
 423         ISupportManager ISupport;
 424
 425         /** Get the current time
 426          * Because this only calls time() once every time around the mainloop,
 427          * it is much faster than calling time() directly.
 428          * @return The current time as an epoch value (time_t)
 429          */
 430         inline time_t Time() { return TIME.tv_sec; }
 431         /** The fractional time at the start of this mainloop iteration (nanoseconds) */
 432         inline long Time_ns() { return TIME.tv_nsec; }
 433         /** Update the current time. Don't call this unless you have reason to do so. */
 434         void UpdateTime();
 435
 436         /** Generate a random string with the given length
 437          * @param length The length in bytes
 438          * @param printable if false, the string will use characters 0-255; otherwise,
 439          * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
 440          */
 441         std::string GenRandomStr(int length, bool printable = true);
 442         /** Generate a random integer.
 443          * This is generally more secure than rand()
 444          */
 445         unsigned long GenRandomInt(unsigned long max);
 446
 447         /** Fill a buffer with random bits */
 448         caller2<void, char*, size_t> GenRandom;
 449
 450         /** Bind all ports specified in the configuration file.
 451          * @return The number of ports bound without error
 452          */
 453         int BindPorts(FailedPortList &failed_ports);
 454
 455         /** Binds a socket on an already open file descriptor
 456          * @param sockfd A valid file descriptor of an open socket
 457          * @param port The port number to bind to
 458          * @param addr The address to bind to (IP only)
 459          * @param dolisten Should this port be listened on?
 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 ONLY
 481          */
 482         User* FindNickOnly(const std::string &nick);
 483
 484         /** Find a channel in the channels hash
 485          * @param chan The channel to find
 486          * @return A pointer to the channel, or NULL if the channel does not exist
 487          */
 488         Channel* FindChan(const std::string &chan);
 489
 490         /** Check we aren't running as root, and exit if we are
 491          * @return Depending on the configuration, this function may never return
 492          */
 493         void CheckRoot();
 494
 495         /** Return true if a channel name is valid
 496          * @param chname A channel name to verify
 497          * @return True if the name is valid
 498          */
 499         caller1<bool, const std::string&> IsChannel;
 500
 501         /** Return true if str looks like a server ID
 502          * @param string to check against
 503          */
 504         static bool IsSID(const std::string& sid);
 505
 506         /** Rehash the local server
 507          */
 508         caller1<void, const std::string&> Rehash;
 509
 510         /** Handles incoming signals after being set
 511          * @param signal the signal recieved
 512          */
 513         void SignalHandler(int signal);
 514
 515         /** Sets the signal recieved
 516          * @param signal the signal recieved
 517          */
 518         static void SetSignal(int signal);
 519
 520         /** Causes the server to exit after unloading modules and
 521          * closing all open file descriptors.
 522          *
 523          * @param status The exit code to give to the operating system
 524          * (See the ExitStatus enum for valid values)
 525          */
 526         void Exit(int status);
 527
 528         /** Causes the server to exit immediately with exit code 0.
 529          * The status code is required for signal handlers, and ignored.
 530          */
 531
 532         /** Printf-wrapper.
 533         * @param How you want it formatted
 534         * @param ...
 535         * @return The formatted string
 536         */
 537         static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
 538         static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 539
 540         static void QuickExit(int status);
 541
 542         /** Return a count of channels on the network
 543          * @return The number of channels
 544          */
 545         long ChannelCount();
 546
 547         /** Send an error notice to all local users, opered and unopered
 548          * @param s The error string to send
 549          */
 550         void SendError(const std::string &s);
 551
 552         /** Return true if a nickname is valid
 553          * @param n A nickname to verify
 554          * @return True if the nick is valid
 555          */
 556         caller1<bool, const std::string&> IsNick;
 557
 558         /** Return true if an ident is valid
 559          * @param An ident to verify
 560          * @return True if the ident is valid
 561          */
 562         caller1<bool, const std::string&> IsIdent;
 563
 564         /** Add a command to this server's command parser
 565          * @param f A Command command handler object to add
 566          * @throw ModuleException Will throw ModuleExcption if the command already exists
 567          */
 568         inline void AddCommand(Command *f)
 569         {
 570                 Modules->AddService(*f);
 571         }
 572
 573         /** Send a modechange.
 574          * The parameters provided are identical to that sent to the
 575          * handler for class cmd_mode.
 576          * @param parameters The mode parameters
 577          * @param user The user to send error messages to
 578          */
 579         void SendMode(const std::vector<std::string>& parameters, User *user);
 580
 581         /** Send a modechange and route it to the network.
 582          * The parameters provided are identical to that sent to the
 583          * handler for class cmd_mode.
 584          * @param parameters The mode parameters
 585          * @param user The user to send error messages to
 586          */
 587         void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
 588
 589         /** Match two strings using pattern matching, optionally, with a map
 590          * to check case against (may be NULL). If map is null, match will be case insensitive.
 591          * @param str The literal string to match against
 592          * @param mask The glob pattern to match against.
 593          * @param map The character map to use when matching.
 594          */
 595         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 596         static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
 597
 598         /** Match two strings using pattern matching, optionally, with a map
 599          * to check case against (may be NULL). If map is null, match will be case insensitive.
 600          * Supports CIDR patterns as well as globs.
 601          * @param str The literal string to match against
 602          * @param mask The glob or CIDR pattern to match against.
 603          * @param map The character map to use when matching.
 604          */
 605         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 606         static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
 607
 608         /** Matches a hostname and IP against a space delimited list of hostmasks.
 609          * @param masks The space delimited masks to match against.
 610          * @param hostname The hostname to try and match.
 611          * @param ipaddr The IP address to try and match.
 612          */
 613         static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 614
 615         /** Return true if the given parameter is a valid nick!user\@host mask
 616          * @param mask A nick!user\@host masak to match against
 617          * @return True i the mask is valid
 618          */
 619         bool IsValidMask(const std::string &mask);
 620
 621         /** Strips all color codes from the given string
 622          * @param sentence The string to strip from
 623          */
 624         static void StripColor(std::string &sentence);
 625
 626         /** Parses color codes from string values to actual color codes
 627          * @param input The data to process
 628          */
 629         static void ProcessColors(file_cache& input);
 630
 631         /** Rehash the local server
 632          */
 633         void RehashServer();
 634
 635         /** Check if the given nickmask matches too many users, send errors to the given user
 636          * @param nick A nickmask to match against
 637          * @param user A user to send error text to
 638          * @return True if the nick matches too many users
 639          */
 640         bool NickMatchesEveryone(const std::string &nick, User* user);
 641
 642         /** Check if the given IP mask matches too many users, send errors to the given user
 643          * @param ip An ipmask to match against
 644          * @param user A user to send error text to
 645          * @return True if the ip matches too many users
 646          */
 647         bool IPMatchesEveryone(const std::string &ip, User* user);
 648
 649         /** Check if the given hostmask matches too many users, send errors to the given user
 650          * @param mask A hostmask to match against
 651          * @param user A user to send error text to
 652          * @return True if the host matches too many users
 653          */
 654         bool HostMatchesEveryone(const std::string &mask, User* user);
 655
 656         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 657          * @param str A string containing a time in the form 1y2w3d4h6m5s
 658          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 659          * @return The total number of seconds
 660          */
 661         static unsigned long Duration(const std::string& str);
 662
 663         /** Attempt to compare a password to a string from the config file.
 664          * This will be passed to handling modules which will compare the data
 665          * against possible hashed equivalents in the input string.
 666          * @param ex The object (user, server, whatever) causing the comparison.
 667          * @param data The data from the config file
 668          * @param input The data input by the oper
 669          * @param hashtype The hash from the config file
 670          * @return 0 if the strings match, 1 or -1 if they do not
 671          */
 672         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 673
 674         /** Check if a given server is a uline.
 675          * An empty string returns true, this is by design.
 676          * @param server The server to check for uline status
 677          * @return True if the server is a uline OR the string is empty
 678          */
 679         bool ULine(const std::string& server);
 680
 681         /** Returns true if the uline is 'silent' (doesnt generate
 682          * remote connect notices etc).
 683          */
 684         bool SilentULine(const std::string& server);
 685
 686         /** Returns the full version string of this ircd
 687          * @return The version string
 688          */
 689         std::string GetVersionString(bool getFullVersion = false);
 690
 691         /** Attempt to write the process id to a given file
 692          * @param filename The PID file to attempt to write to
 693          * @return This function may bail if the file cannot be written
 694          */
 695         void WritePID(const std::string &filename);
 696
 697         /** This constructor initialises all the subsystems and reads the config file.
 698          * @param argc The argument count passed to main()
 699          * @param argv The argument list passed to main()
 700          * @throw <anything> If anything is thrown from here and makes it to
 701          * you, you should probably just give up and go home. Yes, really.
 702          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 703          */
 704         InspIRCd(int argc, char** argv);
 705
 706         /** Send a line of WHOIS data to a user.
 707          * @param user user to send the line to
 708          * @param dest user being WHOISed
 709          * @param numeric Numeric to send
 710          * @param text Text of the numeric
 711          */
 712         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 713
 714         /** Send a line of WHOIS data to a user.
 715          * @param user user to send the line to
 716          * @param dest user being WHOISed
 717          * @param numeric Numeric to send
 718          * @param format Format string for the numeric
 719          * @param ... Parameters for the format string
 720          */
 721         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 722
 723         /** Called to check whether a channel restriction mode applies to a user
 724          * @param User that is attempting some action
 725          * @param Channel that the action is being performed on
 726          * @param Action name
 727          */
 728         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 729
 730         /** Restart the server.
 731          * This function will not return. If an error occurs,
 732          * it will throw an instance of CoreException.
 733          * @param reason The restart reason to show to all clients
 734          * @throw CoreException An instance of CoreException indicating the error from execv().
 735          */
 736         void Restart(const std::string &reason);
 737
 738         /** Prepare the ircd for restart or shutdown.
 739          * This function unloads all modules which can be unloaded,
 740          * closes all open sockets, and closes the logfile.
 741          */
 742         void Cleanup();
 743
 744         /** Return a time_t as a human-readable string.
 745          */
 746         std::string TimeString(time_t curtime);
 747
 748         /** Begin execution of the server.
 749          * NOTE: this function NEVER returns. Internally,
 750          * it will repeatedly loop.
 751          * @return The return value for this function is undefined.
 752          */
 753         int Run();
 754
 755         char* GetReadBuffer()
 756         {
 757                 return this->ReadBuffer;
 758         }
 759 };
 760
 761 ENTRYPOINT;
 762
 763 template<class Cmd>
 764 class CommandModule : public Module
 765 {
 766         Cmd cmd;
 767  public:
 768         CommandModule() : cmd(this)
 769         {
 770         }
 771
 772         void init()
 773         {
 774                 ServerInstance->Modules->AddService(cmd);
 775         }
 776
 777         Version GetVersion()
 778         {
 779                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 780         }
 781 };