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