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_HANDLER2(IsNickHandler, bool, const char*, size_t);
 281 DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
 282 DEFINE_HANDLER1(FloodQuitUserHandler, void, User*);
 283 DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t);
 284 DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
 285 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 286
 287 /* Forward declaration - required */
 288 class XLineManager;
 289 class BanCacheManager;
 290
 291 /** The background thread for config reading, so that reading from executable includes
 292  * does not block.
 293  */
 294 class CoreExport ConfigReaderThread : public Thread
 295 {
 296         ServerConfig* Config;
 297         bool done;
 298  public:
 299         std::string TheUserUID;
 300         ConfigReaderThread(const std::string &useruid)
 301                 : Thread(), done(false), TheUserUID(useruid)
 302         {
 303         }
 304
 305         virtual ~ConfigReaderThread()
 306         {
 307         }
 308
 309         void Run();
 310         /** Run in the main thread to apply the configuration */
 311         void Finish();
 312         bool IsDone() { return done; }
 313 };
 314
 315 /** The main class of the irc server.
 316  * This class contains instances of all the other classes
 317  * in this software, with the exception of the base class,
 318  * classbase. Amongst other things, it contains a ModeParser,
 319  * a DNS object, a CommandParser object, and a list of active
 320  * Module objects, and facilities for Module objects to
 321  * interact with the core system it implements.
 322  */
 323 class CoreExport InspIRCd : public classbase
 324 {
 325  private:
 326         /** Holds the current UID. Used to generate the next one.
 327          */
 328         char current_uid[UUID_LENGTH];
 329
 330         /** Set up the signal handlers
 331          */
 332         void SetSignals();
 333
 334         /** Daemonize the ircd and close standard input/output streams
 335          * @return True if the program daemonized succesfully
 336          */
 337         bool DaemonSeed();
 338
 339         /** Iterate the list of BufferedSocket objects, removing ones which have timed out
 340          * @param TIME the current time
 341          */
 342         void DoSocketTimeouts(time_t TIME);
 343
 344         /** Increments the current UID by one.
 345          */
 346         void IncrementUID(int pos);
 347
 348         /** Perform background user events such as PING checks
 349          */
 350         void DoBackgroundUserStuff();
 351
 352         /** Returns true when all modules have done pre-registration checks on a user
 353          * @param user The user to verify
 354          * @return True if all modules have finished checking this user
 355          */
 356         bool AllModulesReportReady(User* user);
 357
 358         /** Logfile pathname specified on the commandline, or empty string
 359          */
 360         char LogFileName[MAXBUF];
 361
 362         /** The current time, updated in the mainloop
 363          */
 364         time_t TIME;
 365
 366         /** The time that was recorded last time around the mainloop
 367          */
 368         time_t OLDTIME;
 369
 370         /** A 64k buffer used to read socket data into
 371          * NOTE: update ValidateNetBufferSize if you change this
 372          */
 373         char ReadBuffer[65535];
 374
 375 #ifdef WIN32
 376         IPC* WindowsIPC;
 377 #endif
 378
 379  public:
 380
 381         /** Global cull list, will be processed on next iteration
 382          */
 383         CullList GlobalCulls;
 384
 385         /**** Functors ****/
 386
 387         IsNickHandler HandleIsNick;
 388         IsIdentHandler HandleIsIdent;
 389         FloodQuitUserHandler HandleFloodQuitUser;
 390         IsChannelHandler HandleIsChannel;
 391         IsSIDHandler HandleIsSID;
 392         RehashHandler HandleRehash;
 393
 394         /** 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
 395          * Reason for it:
 396          * kludge alert!
 397          * SendMode expects a User* to send the numeric replies
 398          * back to, so we create it a fake user that isnt in the user
 399          * hash and set its descriptor to FD_MAGIC_NUMBER so the data
 400          * falls into the abyss :p
 401          */
 402         FakeUser* FakeClient;
 403
 404         /** Returns the next available UID for this server.
 405          */
 406         std::string GetUID();
 407
 408         /** Find a user in the UUID hash
 409          * @param nick The nickname to find
 410          * @return A pointer to the user, or NULL if the user does not exist
 411          */
 412         User* FindUUID(const std::string &);
 413
 414         /** Find a user in the UUID hash
 415          * @param nick The nickname to find
 416          * @return A pointer to the user, or NULL if the user does not exist
 417          */
 418         User* FindUUID(const char *);
 419
 420         /** Build the ISUPPORT string by triggering all modules On005Numeric events
 421          */
 422         void BuildISupport();
 423
 424         /** List of server names we've seen.
 425          */
 426         servernamelist servernames;
 427
 428         /** Time this ircd was booted
 429          */
 430         time_t startup_time;
 431
 432         /** Config file pathname specified on the commandline or via ./configure
 433          */
 434         std::string ConfigFileName;
 435
 436         /** Mode handler, handles mode setting and removal
 437          */
 438         ModeParser* Modes;
 439
 440         /** Command parser, handles client to server commands
 441          */
 442         CommandParser* Parser;
 443
 444         /** Socket engine, handles socket activity events
 445          */
 446         SocketEngine* SE;
 447
 448         /** Thread engine, Handles threading where required
 449          */
 450         ThreadEngine* Threads;
 451
 452         /** The thread/class used to read config files in REHASH and on startup
 453          */
 454         ConfigReaderThread* ConfigThread;
 455
 456         /** LogManager handles logging.
 457          */
 458         LogManager *Logs;
 459
 460         /** ModuleManager contains everything related to loading/unloading
 461          * modules.
 462          */
 463         ModuleManager* Modules;
 464
 465         /** BanCacheManager is used to speed up checking of restrictions on connection
 466          * to the IRCd.
 467          */
 468         BanCacheManager *BanCache;
 469
 470         /** Stats class, holds miscellaneous stats counters
 471          */
 472         serverstats* stats;
 473
 474         /**  Server Config class, holds configuration file data
 475          */
 476         ServerConfig* Config;
 477
 478         /** Snomask manager - handles routing of snomask messages
 479          * to opers.
 480          */
 481         SnomaskManager* SNO;
 482
 483         /** DNS class, provides resolver facilities to the core and modules
 484          */
 485         DNS* Res;
 486
 487         /** Timer manager class, triggers Timer timer events
 488          */
 489         TimerManager* Timers;
 490
 491         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 492          */
 493         XLineManager* XLines;
 494
 495         /** User manager. Various methods and data associated with users.
 496          */
 497         UserManager *Users;
 498
 499         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 500          */
 501         chan_hash* chanlist;
 502
 503         /** List of the open ports
 504          */
 505         std::vector<ListenSocketBase *> ports;
 506
 507         /** Set to the current signal recieved
 508          */
 509         int s_signal;
 510
 511         /** Protocol interface, overridden by server protocol modules
 512          */
 513         ProtocolInterface* PI;
 514
 515         /** Get the current time
 516          * Because this only calls time() once every time around the mainloop,
 517          * it is much faster than calling time() directly.
 518          * @return The current time as an epoch value (time_t)
 519          */
 520         time_t Time();
 521
 522         /** Bind all ports specified in the configuration file.
 523          * @return The number of ports bound without error
 524          */
 525         int BindPorts(FailedPortList &failed_ports);
 526
 527         /** Binds a socket on an already open file descriptor
 528          * @param sockfd A valid file descriptor of an open socket
 529          * @param port The port number to bind to
 530          * @param addr The address to bind to (IP only)
 531          * @return True if the port was bound successfully
 532          */
 533         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
 534
 535         /** Adds a server name to the list of servers we've seen
 536          * @param The servername to add
 537          */
 538         void AddServerName(const std::string &servername);
 539
 540         /** Finds a cached char* pointer of a server name,
 541          * This is used to optimize User by storing only the pointer to the name
 542          * @param The servername to find
 543          * @return A pointer to this name, gauranteed to never become invalid
 544          */
 545         const char* FindServerNamePtr(const std::string &servername);
 546
 547         /** Returns true if we've seen the given server name before
 548          * @param The servername to find
 549          * @return True if we've seen this server name before
 550          */
 551         bool FindServerName(const std::string &servername);
 552
 553         /** Gets the GECOS (description) field of the given server.
 554          * If the servername is not that of the local server, the name
 555          * is passed to handling modules which will attempt to determine
 556          * the GECOS that bleongs to the given servername.
 557          * @param servername The servername to find the description of
 558          * @return The description of this server, or of the local server
 559          */
 560         std::string GetServerDescription(const char* servername);
 561
 562         /** Find a user in the nick hash.
 563          * If the user cant be found in the nick hash check the uuid hash
 564          * @param nick The nickname to find
 565          * @return A pointer to the user, or NULL if the user does not exist
 566          */
 567         User* FindNick(const std::string &nick);
 568
 569         /** Find a user in the nick hash.
 570          * If the user cant be found in the nick hash check the uuid hash
 571          * @param nick The nickname to find
 572          * @return A pointer to the user, or NULL if the user does not exist
 573          */
 574         User* FindNick(const char* nick);
 575
 576         /** Find a user in the nick hash ONLY
 577          */
 578         User* FindNickOnly(const char* nick);
 579
 580         /** Find a user in the nick hash ONLY
 581          */
 582         User* FindNickOnly(const std::string &nick);
 583
 584         /** Find a channel in the channels hash
 585          * @param chan The channel to find
 586          * @return A pointer to the channel, or NULL if the channel does not exist
 587          */
 588         Channel* FindChan(const std::string &chan);
 589
 590         /** Find a channel in the channels hash
 591          * @param chan The channel to find
 592          * @return A pointer to the channel, or NULL if the channel does not exist
 593          */
 594         Channel* FindChan(const char* chan);
 595
 596         /** Check we aren't running as root, and exit if we are
 597          * @return Depending on the configuration, this function may never return
 598          */
 599         void CheckRoot();
 600
 601         /** Determine the right path for, and open, the logfile
 602          * @param argv The argv passed to main() initially, used to calculate program path
 603          * @param argc The argc passed to main() initially, used to calculate program path
 604          * @return True if the log could be opened, false if otherwise
 605          */
 606         bool OpenLog(char** argv, int argc);
 607
 608         /** Return true if a channel name is valid
 609          * @param chname A channel name to verify
 610          * @return True if the name is valid
 611          */
 612         caller2<bool, const char*, size_t> IsChannel;
 613
 614         /** Return true if str looks like a server ID
 615          * @param string to check against
 616          */
 617         caller1<bool, const std::string&> IsSID;
 618
 619         /** Rehash the local server
 620          */
 621         caller1<void, const std::string&> Rehash;
 622
 623         /** Handles incoming signals after being set
 624          * @param signal the signal recieved
 625          */
 626         void SignalHandler(int signal);
 627
 628         /** Sets the signal recieved
 629          * @param signal the signal recieved
 630          */
 631         static void SetSignal(int signal);
 632
 633         /** Causes the server to exit after unloading modules and
 634          * closing all open file descriptors.
 635          *
 636          * @param The exit code to give to the operating system
 637          * (See the ExitStatus enum for valid values)
 638          */
 639         void Exit(int status);
 640
 641         /** Causes the server to exit immediately with exit code 0.
 642          * The status code is required for signal handlers, and ignored.
 643          */
 644         static void QuickExit(int status);
 645
 646         /** Return a count of channels on the network
 647          * @return The number of channels
 648          */
 649         long ChannelCount();
 650
 651         /** Send an error notice to all local users, opered and unopered
 652          * @param s The error string to send
 653          */
 654         void SendError(const std::string &s);
 655
 656         /** Return true if a nickname is valid
 657          * @param n A nickname to verify
 658          * @return True if the nick is valid
 659          */
 660         caller2<bool, const char*, size_t> IsNick;
 661
 662         /** Return true if an ident is valid
 663          * @param An ident to verify
 664          * @return True if the ident is valid
 665          */
 666         caller1<bool, const char*> IsIdent;
 667
 668         /** Add a dns Resolver class to this server's active set
 669          * @param r The resolver to add
 670          * @param cached If this value is true, then the cache will
 671          * be searched for the DNS result, immediately. If the value is
 672          * false, then a request will be sent to the nameserver, and the
 673          * result will not be immediately available. You should usually
 674          * use the boolean value which you passed to the Resolver
 675          * constructor, which Resolver will set appropriately depending
 676          * on if cached results are available and haven't expired. It is
 677          * however safe to force this value to false, forcing a remote DNS
 678          * lookup, but not an update of the cache.
 679          * @return True if the operation completed successfully. Note that
 680          * if this method returns true, you should not attempt to access
 681          * the resolver class you pass it after this call, as depending upon
 682          * the request given, the object may be deleted!
 683          */
 684         bool AddResolver(Resolver* r, bool cached);
 685
 686         /** Add a command to this server's command parser
 687          * @param f A Command command handler object to add
 688          * @throw ModuleException Will throw ModuleExcption if the command already exists
 689          */
 690         void AddCommand(Command *f);
 691
 692         /** Send a modechange.
 693          * The parameters provided are identical to that sent to the
 694          * handler for class cmd_mode.
 695          * @param parameters The mode parameters
 696          * @param user The user to send error messages to
 697          */
 698         void SendMode(const std::vector<std::string>& parameters, User *user);
 699
 700         /** Match two strings using pattern matching, optionally, with a map
 701          * to check case against (may be NULL). If map is null, match will be case insensitive.
 702          * @param str The literal string to match against
 703          * @param mask The glob pattern to match against.
 704          */
 705         static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 706         static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
 707
 708         /** Match two strings using pattern matching, optionally, with a map
 709          * to check case against (may be NULL). If map is null, match will be case insensitive.
 710          * Supports CIDR patterns as well as globs.
 711          * @param str The literal string to match against
 712          * @param mask The glob or CIDR pattern to match against.
 713          */
 714         static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
 715         static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
 716
 717         /** Call the handler for a given command.
 718          * @param commandname The command whos handler you wish to call
 719          * @param parameters The mode parameters
 720          * @param pcnt The number of items you have given in the first parameter
 721          * @param user The user to execute the command as
 722          * @return True if the command handler was called successfully
 723          */
 724         CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
 725
 726         /** Return true if the command is a module-implemented command and the given parameters are valid for it
 727          * @param parameters The mode parameters
 728          * @param pcnt The number of items you have given in the first parameter
 729          * @param user The user to test-execute the command as
 730          * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
 731          */
 732         bool IsValidModuleCommand(const std::string &commandname, int pcnt, User* user);
 733
 734         /** Return true if the given parameter is a valid nick!user\@host mask
 735          * @param mask A nick!user\@host masak to match against
 736          * @return True i the mask is valid
 737          */
 738         bool IsValidMask(const std::string &mask);
 739
 740         /** Rehash the local server
 741          */
 742         void RehashServer();
 743
 744         /** Return the channel whos index number matches that provided
 745          * @param The index number of the channel to fetch
 746          * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
 747          */
 748         Channel* GetChannelIndex(long index);
 749
 750         /** Dump text to a user target, splitting it appropriately to fit
 751          * @param User the user to dump the text to
 752          * @param LinePrefix text to prefix each complete line with
 753          * @param TextStream the text to send to the user
 754          */
 755         void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream);
 756
 757         /** Dump text to a user target (local or remote)
 758          * @param user the user to dump the text to
 759          * @param text the full line of text
 760          */
 761         void DumpText(User* user, const std::string &text);
 762
 763         /** Dump text to a user target (local or remote)
 764          * @param user the user to dump the text to
 765          * @param format the printf format string for the text to send
 766          */
 767         void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
 768
 769         /** Check if the given nickmask matches too many users, send errors to the given user
 770          * @param nick A nickmask to match against
 771          * @param user A user to send error text to
 772          * @return True if the nick matches too many users
 773          */
 774         bool NickMatchesEveryone(const std::string &nick, User* user);
 775
 776         /** Check if the given IP mask matches too many users, send errors to the given user
 777          * @param ip An ipmask to match against
 778          * @param user A user to send error text to
 779          * @return True if the ip matches too many users
 780          */
 781         bool IPMatchesEveryone(const std::string &ip, User* user);
 782
 783         /** Check if the given hostmask matches too many users, send errors to the given user
 784          * @param mask A hostmask to match against
 785          * @param user A user to send error text to
 786          * @return True if the host matches too many users
 787          */
 788         bool HostMatchesEveryone(const std::string &mask, User* user);
 789
 790         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 791          * @param str A string containing a time in the form 1y2w3d4h6m5s
 792          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 793          * @return The total number of seconds
 794          */
 795         long Duration(const std::string &str);
 796
 797         /** Attempt to compare a password to a string from the config file.
 798          * This will be passed to handling modules which will compare the data
 799          * against possible hashed equivalents in the input string.
 800          * @param ex The object (user, server, whatever) causing the comparison.
 801          * @param data The data from the config file
 802          * @param input The data input by the oper
 803          * @param hashtype The hash from the config file
 804          * @return 0 if the strings match, 1 or -1 if they do not
 805          */
 806         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 807
 808         /** Check if a given server is a uline.
 809          * An empty string returns true, this is by design.
 810          * @param server The server to check for uline status
 811          * @return True if the server is a uline OR the string is empty
 812          */
 813         bool ULine(const char* server);
 814
 815         /** Returns true if the uline is 'silent' (doesnt generate
 816          * remote connect notices etc).
 817          */
 818         bool SilentULine(const char* server);
 819
 820         /** Returns the subversion revision ID of this ircd
 821          * @return The revision ID or an empty string
 822          */
 823         std::string GetRevision();
 824
 825         /** Returns the full version string of this ircd
 826          * @return The version string
 827          */
 828         std::string GetVersionString();
 829
 830         /** Attempt to write the process id to a given file
 831          * @param filename The PID file to attempt to write to
 832          * @return This function may bail if the file cannot be written
 833          */
 834         void WritePID(const std::string &filename);
 835
 836         /** This constructor initialises all the subsystems and reads the config file.
 837          * @param argc The argument count passed to main()
 838          * @param argv The argument list passed to main()
 839          * @throw <anything> If anything is thrown from here and makes it to
 840          * you, you should probably just give up and go home. Yes, really.
 841          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 842          */
 843         InspIRCd(int argc, char** argv);
 844
 845         /** Send a line of WHOIS data to a user.
 846          * @param user user to send the line to
 847          * @param dest user being WHOISed
 848          * @param numeric Numeric to send
 849          * @param text Text of the numeric
 850          */
 851         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 852
 853         /** Send a line of WHOIS data to a user.
 854          * @param user user to send the line to
 855          * @param dest user being WHOISed
 856          * @param numeric Numeric to send
 857          * @param format Format string for the numeric
 858          * @param ... Parameters for the format string
 859          */
 860         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 861
 862         /** Handle /STATS
 863          */
 864         void DoStats(char statschar, User* user, string_list &results);
 865
 866         /** Handle /WHOIS
 867          */
 868         void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
 869
 870         /** Quit a user for excess flood, and if they are not
 871          * fully registered yet, temporarily zline their IP.
 872          * @param current user to quit
 873          */
 874         caller1<void, User*> FloodQuitUser;
 875
 876         /** Restart the server.
 877          * This function will not return. If an error occurs,
 878          * it will throw an instance of CoreException.
 879          * @param reason The restart reason to show to all clients
 880          * @throw CoreException An instance of CoreException indicating the error from execv().
 881          */
 882         void Restart(const std::string &reason);
 883
 884         /** Prepare the ircd for restart or shutdown.
 885          * This function unloads all modules which can be unloaded,
 886          * closes all open sockets, and closes the logfile.
 887          */
 888         void Cleanup();
 889
 890         /** This copies the user and channel hash_maps into new hash maps.
 891          * This frees memory used by the hash_map allocator (which it neglects
 892          * to free, most of the time, using tons of ram)
 893          */
 894         void RehashUsersAndChans();
 895
 896         /** Resets the cached max bans value on all channels.
 897          * Called by rehash.
 898          */
 899         void ResetMaxBans();
 900
 901         /** Return a time_t as a human-readable string.
 902          */
 903         std::string TimeString(time_t curtime);
 904
 905         /** Begin execution of the server.
 906          * NOTE: this function NEVER returns. Internally,
 907          * it will repeatedly loop.
 908          * @return The return value for this function is undefined.
 909          */
 910         int Run();
 911
 912         /** Adds an extban char to the 005 token.
 913          */
 914         void AddExtBanChar(char c);
 915
 916         char* GetReadBuffer()
 917         {
 918                 return this->ReadBuffer;
 919         }
 920 };
 921
 922 ENTRYPOINT;
 923
 924 template<class Cmd>
 925 class CommandModule : public Module
 926 {
 927         Cmd cmd;
 928  public:
 929         CommandModule() : cmd(this)
 930         {
 931                 ServerInstance->AddCommand(&cmd);
 932         }
 933
 934         Version GetVersion()
 935         {
 936                 return Version(cmd.command, VF_VENDOR);
 937         }
 938 };
 939
 940 #endif