include/inspircd.h

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