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