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