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