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_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
 250 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 251 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
 252 DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
 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         static const char LogHeader[];
 328
 329         /** Find a user in the UUID hash
 330          * @param uid The UUID to find
 331          * @return A pointer to the user, or NULL if the user does not exist
 332          */
 333         User* FindUUID(const std::string &uid);
 334
 335         /** Time this ircd was booted
 336          */
 337         time_t startup_time;
 338
 339         /** Config file pathname specified on the commandline or via ./configure
 340          */
 341         std::string ConfigFileName;
 342
 343         ExtensionManager Extensions;
 344
 345         /** Mode handler, handles mode setting and removal
 346          */
 347         ModeParser* Modes;
 348
 349         /** Command parser, handles client to server commands
 350          */
 351         CommandParser* Parser;
 352
 353         /** Socket engine, handles socket activity events
 354          */
 355         SocketEngine* SE;
 356
 357         /** Thread engine, Handles threading where required
 358          */
 359         ThreadEngine* Threads;
 360
 361         /** The thread/class used to read config files in REHASH and on startup
 362          */
 363         ConfigReaderThread* ConfigThread;
 364
 365         /** LogManager handles logging.
 366          */
 367         LogManager *Logs;
 368
 369         /** ModuleManager contains everything related to loading/unloading
 370          * modules.
 371          */
 372         ModuleManager* Modules;
 373
 374         /** BanCacheManager is used to speed up checking of restrictions on connection
 375          * to the IRCd.
 376          */
 377         BanCacheManager *BanCache;
 378
 379         /** Stats class, holds miscellaneous stats counters
 380          */
 381         serverstats* stats;
 382
 383         /**  Server Config class, holds configuration file data
 384          */
 385         ServerConfig* Config;
 386
 387         /** Snomask manager - handles routing of snomask messages
 388          * to opers.
 389          */
 390         SnomaskManager* SNO;
 391
 392         /** Timer manager class, triggers Timer timer events
 393          */
 394         TimerManager* Timers;
 395
 396         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 397          */
 398         XLineManager* XLines;
 399
 400         /** User manager. Various methods and data associated with users.
 401          */
 402         UserManager *Users;
 403
 404         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 405          */
 406         chan_hash* chanlist;
 407
 408         /** List of the open ports
 409          */
 410         std::vector<ListenSocket*> ports;
 411
 412         /** Set to the current signal recieved
 413          */
 414         static sig_atomic_t s_signal;
 415
 416         /** Protocol interface, overridden by server protocol modules
 417          */
 418         ProtocolInterface* PI;
 419
 420         /** Holds extensible for user nickforced
 421          */
 422         LocalIntExt NICKForced;
 423
 424         /** Holds extensible for user operquit
 425          */
 426         LocalStringExt OperQuit;
 427
 428         /** Manages the generation and transmission of ISUPPORT. */
 429         ISupportManager ISupport;
 430
 431         /** Get the current time
 432          * Because this only calls time() once every time around the mainloop,
 433          * it is much faster than calling time() directly.
 434          * @return The current time as an epoch value (time_t)
 435          */
 436         inline time_t Time() { return TIME.tv_sec; }
 437         /** The fractional time at the start of this mainloop iteration (nanoseconds) */
 438         inline long Time_ns() { return TIME.tv_nsec; }
 439         /** Update the current time. Don't call this unless you have reason to do so. */
 440         void UpdateTime();
 441
 442         /** Generate a random string with the given length
 443          * @param length The length in bytes
 444          * @param printable if false, the string will use characters 0-255; otherwise,
 445          * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
 446          */
 447         std::string GenRandomStr(int length, bool printable = true);
 448         /** Generate a random integer.
 449          * This is generally more secure than rand()
 450          */
 451         unsigned long GenRandomInt(unsigned long max);
 452
 453         /** Fill a buffer with random bits */
 454         caller2<void, char*, size_t> GenRandom;
 455
 456         /** Bind all ports specified in the configuration file.
 457          * @return The number of ports bound without error
 458          */
 459         int BindPorts(FailedPortList &failed_ports);
 460
 461         /** Binds a socket on an already open file descriptor
 462          * @param sockfd A valid file descriptor of an open socket
 463          * @param port The port number to bind to
 464          * @param addr The address to bind to (IP only)
 465          * @param dolisten Should this port be listened on?
 466          * @return True if the port was bound successfully
 467          */
 468         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
 469
 470         /** Gets the GECOS (description) field of the given server.
 471          * If the servername is not that of the local server, the name
 472          * is passed to handling modules which will attempt to determine
 473          * the GECOS that bleongs to the given servername.
 474          * @param servername The servername to find the description of
 475          * @return The description of this server, or of the local server
 476          */
 477         std::string GetServerDescription(const std::string& servername);
 478
 479         /** Find a user in the nick hash.
 480          * If the user cant be found in the nick hash check the uuid hash
 481          * @param nick The nickname to find
 482          * @return A pointer to the user, or NULL if the user does not exist
 483          */
 484         User* FindNick(const std::string &nick);
 485
 486         /** Find a user in the nick hash ONLY
 487          */
 488         User* FindNickOnly(const std::string &nick);
 489
 490         /** Find a channel in the channels hash
 491          * @param chan The channel to find
 492          * @return A pointer to the channel, or NULL if the channel does not exist
 493          */
 494         Channel* FindChan(const std::string &chan);
 495
 496         /** Check we aren't running as root, and exit if we are
 497          * @return Depending on the configuration, this function may never return
 498          */
 499         void CheckRoot();
 500
 501         /** Determine the right path for, and open, the logfile
 502          * @param argv The argv passed to main() initially, used to calculate program path
 503          * @param argc The argc passed to main() initially, used to calculate program path
 504          * @return True if the log could be opened, false if otherwise
 505          */
 506         bool OpenLog(char** argv, int argc);
 507
 508         /** Return true if a channel name is valid
 509          * @param chname A channel name to verify
 510          * @return True if the name is valid
 511          */
 512         caller2<bool, const std::string&, size_t> IsChannel;
 513
 514         /** Return true if str looks like a server ID
 515          * @param string to check against
 516          */
 517         static bool IsSID(const std::string& sid);
 518
 519         /** Rehash the local server
 520          */
 521         caller1<void, const std::string&> Rehash;
 522
 523         /** Handles incoming signals after being set
 524          * @param signal the signal recieved
 525          */
 526         void SignalHandler(int signal);
 527
 528         /** Sets the signal recieved
 529          * @param signal the signal recieved
 530          */
 531         static void SetSignal(int signal);
 532
 533         /** Causes the server to exit after unloading modules and
 534          * closing all open file descriptors.
 535          *
 536          * @param status The exit code to give to the operating system
 537          * (See the ExitStatus enum for valid values)
 538          */
 539         void Exit(int status);
 540
 541         /** Causes the server to exit immediately with exit code 0.
 542          * The status code is required for signal handlers, and ignored.
 543          */
 544         static void QuickExit(int status);
 545
 546         /** Return a count of channels on the network
 547          * @return The number of channels
 548          */
 549         long ChannelCount();
 550
 551         /** Send an error notice to all local users, opered and unopered
 552          * @param s The error string to send
 553          */
 554         void SendError(const std::string &s);
 555
 556         /** Return true if a nickname is valid
 557          * @param n A nickname to verify
 558          * @return True if the nick is valid
 559          */
 560         caller2<bool, const std::string&, size_t> IsNick;
 561
 562         /** Return true if an ident is valid
 563          * @param An ident to verify
 564          * @return True if the ident is valid
 565          */
 566         caller1<bool, const std::string&> IsIdent;
 567
 568         /** Add a command to this server's command parser
 569          * @param f A Command command handler object to add
 570          * @throw ModuleException Will throw ModuleExcption if the command already exists
 571          */
 572         inline void AddCommand(Command *f)
 573         {
 574                 Modules->AddService(*f);
 575         }
 576
 577         /** Send a modechange.
 578          * The parameters provided are identical to that sent to the
 579          * handler for class cmd_mode.
 580          * @param parameters The mode parameters
 581          * @param user The user to send error messages to
 582          */
 583         void SendMode(const std::vector<std::string>& parameters, User *user);
 584
 585         /** Send a modechange and route it to the network.
 586          * The parameters provided are identical to that sent to the
 587          * handler for class cmd_mode.
 588          * @param parameters The mode parameters
 589          * @param user The user to send error messages to
 590          */
 591         void SendGlobalMode(const std::vector<std::string>& parameters, User *user);
 592
 593         /** Match two strings using pattern matching, optionally, with a map
 594          * to check case against (may be NULL). If map is null, match will be case insensitive.
 595          * @param str The literal string to match against
 596          * @param mask The glob pattern to match against.
 597          * @param map The character map to use when matching.
 598          */
 599         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 600         static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
 601
 602         /** Match two strings using pattern matching, optionally, with a map
 603          * to check case against (may be NULL). If map is null, match will be case insensitive.
 604          * Supports CIDR patterns as well as globs.
 605          * @param str The literal string to match against
 606          * @param mask The glob or CIDR pattern to match against.
 607          * @param map The character map to use when matching.
 608          */
 609         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 610         static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
 611
 612         /** Return true if the given parameter is a valid nick!user\@host mask
 613          * @param mask A nick!user\@host masak to match against
 614          * @return True i the mask is valid
 615          */
 616         bool IsValidMask(const std::string &mask);
 617
 618         /** Strips all color codes from the given string
 619          * @param sentence The string to strip from
 620          */
 621         static void StripColor(std::string &sentence);
 622
 623         /** Parses color codes from string values to actual color codes
 624          * @param input The data to process
 625          */
 626         static void ProcessColors(file_cache& input);
 627
 628         /** Rehash the local server
 629          */
 630         void RehashServer();
 631
 632         /** Check if the given nickmask matches too many users, send errors to the given user
 633          * @param nick A nickmask to match against
 634          * @param user A user to send error text to
 635          * @return True if the nick matches too many users
 636          */
 637         bool NickMatchesEveryone(const std::string &nick, User* user);
 638
 639         /** Check if the given IP mask matches too many users, send errors to the given user
 640          * @param ip An ipmask to match against
 641          * @param user A user to send error text to
 642          * @return True if the ip matches too many users
 643          */
 644         bool IPMatchesEveryone(const std::string &ip, User* user);
 645
 646         /** Check if the given hostmask matches too many users, send errors to the given user
 647          * @param mask A hostmask to match against
 648          * @param user A user to send error text to
 649          * @return True if the host matches too many users
 650          */
 651         bool HostMatchesEveryone(const std::string &mask, User* user);
 652
 653         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 654          * @param str A string containing a time in the form 1y2w3d4h6m5s
 655          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 656          * @return The total number of seconds
 657          */
 658         static unsigned long Duration(const std::string& str);
 659
 660         /** Attempt to compare a password to a string from the config file.
 661          * This will be passed to handling modules which will compare the data
 662          * against possible hashed equivalents in the input string.
 663          * @param ex The object (user, server, whatever) causing the comparison.
 664          * @param data The data from the config file
 665          * @param input The data input by the oper
 666          * @param hashtype The hash from the config file
 667          * @return 0 if the strings match, 1 or -1 if they do not
 668          */
 669         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 670
 671         /** Check if a given server is a uline.
 672          * An empty string returns true, this is by design.
 673          * @param server The server to check for uline status
 674          * @return True if the server is a uline OR the string is empty
 675          */
 676         bool ULine(const std::string& server);
 677
 678         /** Returns true if the uline is 'silent' (doesnt generate
 679          * remote connect notices etc).
 680          */
 681         bool SilentULine(const std::string& server);
 682
 683         /** Returns the full version string of this ircd
 684          * @return The version string
 685          */
 686         std::string GetVersionString(bool rawversion = false);
 687
 688         /** Attempt to write the process id to a given file
 689          * @param filename The PID file to attempt to write to
 690          * @return This function may bail if the file cannot be written
 691          */
 692         void WritePID(const std::string &filename);
 693
 694         /** This constructor initialises all the subsystems and reads the config file.
 695          * @param argc The argument count passed to main()
 696          * @param argv The argument list passed to main()
 697          * @throw <anything> If anything is thrown from here and makes it to
 698          * you, you should probably just give up and go home. Yes, really.
 699          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 700          */
 701         InspIRCd(int argc, char** argv);
 702
 703         /** Send a line of WHOIS data to a user.
 704          * @param user user to send the line to
 705          * @param dest user being WHOISed
 706          * @param numeric Numeric to send
 707          * @param text Text of the numeric
 708          */
 709         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 710
 711         /** Send a line of WHOIS data to a user.
 712          * @param user user to send the line to
 713          * @param dest user being WHOISed
 714          * @param numeric Numeric to send
 715          * @param format Format string for the numeric
 716          * @param ... Parameters for the format string
 717          */
 718         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 719
 720         /** Called to check whether a channel restriction mode applies to a user
 721          * @param User that is attempting some action
 722          * @param Channel that the action is being performed on
 723          * @param Action name
 724          */
 725         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 726
 727         /** Restart the server.
 728          * This function will not return. If an error occurs,
 729          * it will throw an instance of CoreException.
 730          * @param reason The restart reason to show to all clients
 731          * @throw CoreException An instance of CoreException indicating the error from execv().
 732          */
 733         void Restart(const std::string &reason);
 734
 735         /** Prepare the ircd for restart or shutdown.
 736          * This function unloads all modules which can be unloaded,
 737          * closes all open sockets, and closes the logfile.
 738          */
 739         void Cleanup();
 740
 741         /** Return a time_t as a human-readable string.
 742          */
 743         std::string TimeString(time_t curtime);
 744
 745         /** Begin execution of the server.
 746          * NOTE: this function NEVER returns. Internally,
 747          * it will repeatedly loop.
 748          * @return The return value for this function is undefined.
 749          */
 750         int Run();
 751
 752         char* GetReadBuffer()
 753         {
 754                 return this->ReadBuffer;
 755         }
 756 };
 757
 758 ENTRYPOINT;
 759
 760 template<class Cmd>
 761 class CommandModule : public Module
 762 {
 763         Cmd cmd;
 764  public:
 765         CommandModule() : cmd(this)
 766         {
 767         }
 768
 769         void init()
 770         {
 771                 ServerInstance->Modules->AddService(cmd);
 772         }
 773
 774         Version GetVersion()
 775         {
 776                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 777         }
 778 };