include/inspircd.h

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