include/inspircd.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                     E-mail:
   7  *              <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *          the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __INSPIRCD_H__
  18 #define __INSPIRCD_H__
  19
  20 #include <time.h>
  21 #include <string>
  22 #include <sstream>
  23 #include "inspircd_config.h"
  24 #include "users.h"
  25 #include "channels.h"
  26 #include "socket.h"
  27 #include "mode.h"
  28
  29 #include "socketengine.h"
  30 #include "command_parse.h"
  31
  32 /** Returned by some functions to indicate failure,
  33  * and the exit code of the program if it terminates.
  34  */
  35 #define ERROR -1
  36
  37 /** Crucial defines
  38  */
  39 #define ETIREDGERBILS EAGAIN
  40
  41 /** Debug levels for use with InspIRCd::Log()
  42  */
  43 enum DebugLevel
  44 {
  45         DEBUG           =       10,
  46         VERBOSE         =       20,
  47         DEFAULT         =       30,
  48         SPARSE          =       40,
  49         NONE            =       50,
  50 };
  51
  52 /**
  53  * This define is used in place of strcmp when we
  54  * want to check if a char* string contains only one
  55  * letter. Pretty fast, its just two compares and an
  56  * addition.
  57  */
  58 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
  59
  60 /** Delete a pointer, and NULL its value
  61  */
  62 template<typename T> inline void DELETE(T* x)
  63 {
  64         delete x;
  65         x = NULL;
  66 }
  67
  68 /** Template function to convert any input type to std::string
  69  */
  70 template<typename T> inline std::string ConvToStr(const T &in)
  71 {
  72         std::stringstream tmp;
  73         if (!(tmp << in)) return std::string();
  74         return tmp.str();
  75 }
  76
  77 /** This class contains various STATS counters
  78  * It is used by the InspIRCd class, which internally
  79  * has an instance of it.
  80  */
  81 class serverstats : public classbase
  82 {
  83   public:
  84         /** Number of accepted connections
  85          */
  86         unsigned long statsAccept;
  87         /** Number of failed accepts
  88          */
  89         unsigned long statsRefused;
  90         /** Number of unknown commands seen
  91          */
  92         unsigned long statsUnknown;
  93         /** Number of nickname collisions handled
  94          */
  95         unsigned long statsCollisions;
  96         /** Number of DNS queries sent out
  97          */
  98         unsigned long statsDns;
  99         /** Number of good DNS replies received
 100          * NOTE: This may not tally to the number sent out,
 101          * due to timeouts and other latency issues.
 102          */
 103         unsigned long statsDnsGood;
 104         /** Number of bad (negative) DNS replies received
 105          * NOTE: This may not tally to the number sent out,
 106          * due to timeouts and other latency issues.
 107          */
 108         unsigned long statsDnsBad;
 109         /** Number of inbound connections seen
 110          */
 111         unsigned long statsConnects;
 112         /** Total bytes of data transmitted
 113          */
 114         double statsSent;
 115         /** Total bytes of data received
 116          */
 117         double statsRecv;
 118         /** Number of bound listening ports
 119          */
 120         unsigned long BoundPortCount;
 121
 122         /** The constructor initializes all the counts to zero
 123          */
 124         serverstats()
 125                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
 126                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0),
 127                 BoundPortCount(0)
 128         {
 129         }
 130 };
 131
 132 class InspIRCd;
 133
 134 /** This class implements a nonblocking log-writer.
 135  * Most people writing an ircd give little thought to their disk
 136  * i/o. On a congested system, disk writes can block for long
 137  * periods of time (e.g. if the system is busy and/or swapping
 138  * a lot). If we just use a blocking fprintf() call, this could
 139  * block for undesirable amounts of time (half of a second through
 140  * to whole seconds). We DO NOT want this, so we make our logfile
 141  * nonblocking and hook it into the SocketEngine.
 142  * NB: If the operating system does not support nonblocking file
 143  * I/O (linux seems to, as does freebsd) this will default to
 144  * blocking behaviour.
 145  */
 146 class FileLogger : public EventHandler
 147 {
 148  protected:
 149         /** The creator/owner of this object
 150          */
 151         InspIRCd* ServerInstance;
 152         /** The log file (fd is inside this somewhere,
 153          * we get it out with fileno())
 154          */
 155         FILE* log;
 156         /** Buffer of pending log lines to be written
 157          */
 158         std::string buffer;
 159         /** Number of write operations that have occured
 160          */
 161         int writeops;
 162  public:
 163         /** The constructor takes an already opened logfile.
 164          */
 165         FileLogger(InspIRCd* Instance, FILE* logfile);
 166         /** This returns false, logfiles are writeable.
 167          */
 168         virtual bool Readable();
 169         /** Handle pending write events.
 170          * This will flush any waiting data to disk.
 171          * If any data remains after the fprintf call,
 172          * another write event is scheduled to write
 173          * the rest of the data when possible.
 174          */
 175         virtual void HandleEvent(EventType et);
 176         /** Write one or more preformatted log lines.
 177          * If the data cannot be written immediately,
 178          * this class will insert itself into the
 179          * SocketEngine, and register a write event,
 180          * and when the write event occurs it will
 181          * attempt again to write the data.
 182          */
 183         void WriteLogLine(const std::string &line);
 184         /** Close the log file and cancel any events.
 185          */
 186         virtual void Close();
 187         /** Close the log file and cancel any events.
 188          * (indirectly call Close()
 189          */
 190         virtual ~FileLogger();
 191 };
 192
 193 class XLineManager;
 194
 195 /** The main class of the irc server.
 196  * This class contains instances of all the other classes
 197  * in this software, with the exception of the base class,
 198  * classbase. Amongst other things, it contains a ModeParser,
 199  * a DNS object, a CommandParser object, and a list of active
 200  * Module objects, and facilities for Module objects to
 201  * interact with the core system it implements. You should
 202  * NEVER attempt to instantiate a class of type InspIRCd
 203  * yourself. If you do, this is equivalent to spawning a second
 204  * IRC server, and could have catastrophic consequences for the
 205  * program in terms of ram usage (basically, you could create
 206  * an obese forkbomb built from recursively spawning irc servers!)
 207  */
 208 class InspIRCd : public classbase
 209 {
 210  private:
 211         /** Holds a string describing the last module error to occur
 212          */
 213         char MODERR[MAXBUF];
 214
 215         /** This is an internal flag used by the mainloop
 216          */
 217         bool expire_run;
 218
 219         /** List of server names we've seen.
 220          */
 221         servernamelist servernames;
 222
 223         /** Remove a ModuleFactory pointer
 224          * @param j Index number of the ModuleFactory to remove
 225          */
 226         void EraseFactory(int j);
 227
 228         /** Remove a Module pointer
 229          * @param j Index number of the Module to remove
 230          */
 231         void EraseModule(int j);
 232
 233         /** Build the ISUPPORT string by triggering all modules On005Numeric events
 234          */
 235         void BuildISupport();
 236
 237         /** Move a given module to a specific slot in the list
 238          * @param modulename The module name to relocate
 239          * @param slot The slot to move the module into
 240          */
 241         void MoveTo(std::string modulename,int slot);
 242
 243         /** Display the startup banner
 244          */
 245         void Start();
 246
 247         /** Set up the signal handlers
 248          * @param SEGVHandler create a handler for segfaults (deprecated)
 249          */
 250         void SetSignals(bool SEGVHandler);
 251
 252         /** Daemonize the ircd and close standard input/output streams
 253          * @return True if the program daemonized succesfully
 254          */
 255         bool DaemonSeed();
 256
 257         /** Moves the given module to the last slot in the list
 258          * @param modulename The module name to relocate
 259          */
 260         void MoveToLast(std::string modulename);
 261
 262         /** Moves the given module to the first slot in the list
 263          * @param modulename The module name to relocate
 264          */
 265         void MoveToFirst(std::string modulename);
 266
 267         /** Moves one module to be placed after another in the list
 268          * @param modulename The module name to relocate
 269          * @param after The module name to place the module after
 270          */
 271         void MoveAfter(std::string modulename, std::string after);
 272
 273         /** Moves one module to be placed before another in the list
 274          * @param modulename The module name to relocate
 275          * @param after The module name to place the module before
 276          */
 277         void MoveBefore(std::string modulename, std::string before);
 278
 279         /** Iterate the list of InspSocket objects, removing ones which have timed out
 280          * @param TIME the current time
 281          */
 282         void DoSocketTimeouts(time_t TIME);
 283
 284         /** Perform background user events such as PING checks
 285          * @param TIME the current time
 286          */
 287         void DoBackgroundUserStuff(time_t TIME);
 288
 289         /** Returns true when all modules have done pre-registration checks on a user
 290          * @param user The user to verify
 291          * @return True if all modules have finished checking this user
 292          */
 293         bool AllModulesReportReady(userrec* user);
 294
 295         /** Total number of modules loaded into the ircd, minus one
 296          */
 297         int ModCount;
 298
 299         /** Logfile pathname specified on the commandline, or empty string
 300          */
 301         char LogFileName[MAXBUF];
 302
 303         /** The feature names published by various modules
 304          */
 305         featurelist Features;
 306
 307         /** The current time, updated in the mainloop
 308          */
 309         time_t TIME;
 310
 311         /** The time that was recorded last time around the mainloop
 312          */
 313         time_t OLDTIME;
 314
 315         /** A 64k buffer used to read client lines into
 316          */
 317         char ReadBuffer[65535];
 318
 319         /** Number of seconds in a minute
 320          */
 321         const long duration_m;
 322
 323         /** Number of seconds in an hour
 324          */
 325         const long duration_h;
 326
 327         /** Number of seconds in a day
 328          */
 329         const long duration_d;
 330
 331         /** Number of seconds in a week
 332          */
 333         const long duration_w;
 334
 335         /** Number of seconds in a year
 336          */
 337         const long duration_y;
 338
 339         /** Used when connecting clients
 340          */
 341         insp_sockaddr client, server;
 342
 343         /** Used when connecting clients
 344          */
 345         socklen_t length;
 346
 347         /** Nonblocking file writer
 348          */
 349         FileLogger* Logger;
 350
 351  public:
 352         /** Time this ircd was booted
 353          */
 354         time_t startup_time;
 355
 356         /** Mode handler, handles mode setting and removal
 357          */
 358         ModeParser* Modes;
 359
 360         /** Command parser, handles client to server commands
 361          */
 362         CommandParser* Parser;
 363
 364         /** Socket engine, handles socket activity events
 365          */
 366         SocketEngine* SE;
 367
 368         /** Stats class, holds miscellaneous stats counters
 369          */
 370         serverstats* stats;
 371
 372         /**  Server Config class, holds configuration file data
 373          */
 374         ServerConfig* Config;
 375
 376         /** Module sockets list, holds the active set of InspSocket classes
 377          */
 378         std::vector<InspSocket*> module_sockets;
 379
 380         /** Client list, a hash_map containing all clients, local and remote
 381          */
 382         user_hash clientlist;
 383
 384         /** Channel list, a hash_map containing all channels
 385          */
 386         chan_hash chanlist;
 387
 388         /** Local client list, a vector containing only local clients
 389          */
 390         std::vector<userrec*> local_users;
 391
 392         /** Oper list, a vector containing all local and remote opered users
 393          */
 394         std::vector<userrec*> all_opers;
 395
 396         /** Whowas container, contains a map of vectors of users tracked by WHOWAS
 397          */
 398         irc::whowas::whowas_users whowas;
 399
 400         /** DNS class, provides resolver facilities to the core and modules
 401          */
 402         DNS* Res;
 403
 404         /** Timer manager class, triggers InspTimer timer events
 405          */
 406         TimerManager* Timers;
 407
 408         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 409          */
 410         XLineManager* XLines;
 411
 412         /** A list of Module* module classes
 413          * Note that this list is always exactly 255 in size.
 414          * The actual number of loaded modules is available from GetModuleCount()
 415          */
 416         ModuleList modules;
 417
 418         /** A list of ModuleFactory* module factories
 419          * Note that this list is always exactly 255 in size.
 420          * The actual number of loaded modules is available from GetModuleCount()
 421          */
 422         FactoryList factory;
 423
 424         /** Get the current time
 425          * Because this only calls time() once every time around the mainloop,
 426          * it is much faster than calling time() directly.
 427          * @return The current time as an epoch value (time_t)
 428          */
 429         time_t Time();
 430
 431         /** Process a user whos socket has been flagged as active
 432          * @param cu The user to process
 433          * @return There is no actual return value, however upon exit, the user 'cu' may have been deleted
 434          */
 435         void ProcessUser(userrec* cu);
 436
 437         /** Get the total number of currently loaded modules
 438          * @return The number of loaded modules
 439          */
 440         int GetModuleCount();
 441
 442         /** Find a module by name, and return a Module* to it.
 443          * This is preferred over iterating the module lists yourself.
 444          * @param name The module name to look up
 445          * @return A pointer to the module, or NULL if the module cannot be found
 446          */
 447         Module* FindModule(const std::string &name);
 448
 449         /** Bind all ports specified in the configuration file.
 450          * @param bail True if the function should bail back to the shell on failure
 451          * @return The number of ports actually bound without error
 452          */
 453         int BindPorts(bool bail);
 454
 455         /** Returns true if this server has the given port bound to the given address
 456          * @param port The port number
 457          * @param addr The address
 458          * @return True if we have a port listening on this address
 459          */
 460         bool HasPort(int port, char* addr);
 461
 462         /** Binds a socket on an already open file descriptor
 463          * @param sockfd A valid file descriptor of an open socket
 464          * @param client A sockaddr to use as temporary storage
 465          * @param server A sockaddr to use as temporary storage
 466          * @param port The port number to bind to
 467          * @param addr The address to bind to (IP only)
 468          * @return True if the port was bound successfully
 469          */
 470         bool BindSocket(int sockfd, insp_sockaddr client, insp_sockaddr server, int port, char* addr);
 471
 472         /** Adds a server name to the list of servers we've seen
 473          * @param The servername to add
 474          */
 475         void AddServerName(const std::string &servername);
 476
 477         /** Finds a cached char* pointer of a server name,
 478          * This is used to optimize userrec by storing only the pointer to the name
 479          * @param The servername to find
 480          * @return A pointer to this name, gauranteed to never become invalid
 481          */
 482         const char* FindServerNamePtr(const std::string &servername);
 483
 484         /** Returns true if we've seen the given server name before
 485          * @param The servername to find
 486          * @return True if we've seen this server name before
 487          */
 488         bool FindServerName(const std::string &servername);
 489
 490         /** Gets the GECOS (description) field of the given server.
 491          * If the servername is not that of the local server, the name
 492          * is passed to handling modules which will attempt to determine
 493          * the GECOS that bleongs to the given servername.
 494          * @param servername The servername to find the description of
 495          * @return The description of this server, or of the local server
 496          */
 497         std::string GetServerDescription(const char* servername);
 498
 499         /** Write text to all opers connected to this server
 500          * @param text The text format string
 501          * @param ... Format args
 502          */
 503         void WriteOpers(const char* text, ...);
 504
 505         /** Write text to all opers connected to this server
 506          * @param text The text to send
 507          */
 508         void WriteOpers(const std::string &text);
 509
 510         /** Find a nickname in the nick hash
 511          * @param nick The nickname to find
 512          * @return A pointer to the user, or NULL if the user does not exist
 513          */
 514         userrec* FindNick(const std::string &nick);
 515
 516         /** Find a nickname in the nick hash
 517          * @param nick The nickname to find
 518          * @return A pointer to the user, or NULL if the user does not exist
 519          */
 520         userrec* FindNick(const char* nick);
 521
 522         /** Find a channel in the channels hash
 523          * @param chan The channel to find
 524          * @return A pointer to the channel, or NULL if the channel does not exist
 525          */
 526         chanrec* FindChan(const std::string &chan);
 527
 528         /** Find a channel in the channels hash
 529          * @param chan The channel to find
 530          * @return A pointer to the channel, or NULL if the channel does not exist
 531          */
 532         chanrec* FindChan(const char* chan);
 533
 534         /** Called by the constructor to load all modules from the config file.
 535          */
 536         void LoadAllModules();
 537
 538         /** Check for a 'die' tag in the config file, and abort if found
 539          * @return Depending on the configuration, this function may never return
 540          */
 541         void CheckDie();
 542
 543         /** Check we aren't running as root, and exit if we are
 544          * @return Depending on the configuration, this function may never return
 545          */
 546         void CheckRoot();
 547
 548         /** Determine the right path for, and open, the logfile
 549          * @param argv The argv passed to main() initially, used to calculate program path
 550          * @param argc The argc passed to main() initially, used to calculate program path
 551          */
 552         void OpenLog(char** argv, int argc);
 553
 554         /** Convert a user to a pseudoclient, disconnecting the real user
 555          * @param user The user to convert
 556          * @param message The quit message to display when exiting the user
 557          * @return True if the operation succeeded
 558          */
 559         bool UserToPseudo(userrec* user, const std::string &message);
 560
 561         /** Convert a pseudoclient to a real user, discarding the pseudoclient
 562          * @param alive A live client
 563          * @param zombie A pseudoclient
 564          * @param message The message to display when quitting the pseudoclient
 565          * @return True if the operation succeeded
 566          */
 567         bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
 568
 569         /** Send a server notice to all local users
 570          * @param text The text format string to send
 571          * @param ... The format arguments
 572          */
 573         void ServerNoticeAll(char* text, ...);
 574
 575         /** Send a server message (PRIVMSG) to all local users
 576          * @param text The text format string to send
 577          * @param ... The format arguments
 578          */
 579         void ServerPrivmsgAll(char* text, ...);
 580
 581         /** Send text to all users with a specific set of modes
 582          * @param modes The modes to check against, without a +, e.g. 'og'
 583          * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
 584          * mode characters in the first parameter causes receipt of the message, and
 585          * if you specify WM_OR, all the modes must be present.
 586          * @param text The text format string to send
 587          * @param ... The format arguments
 588          */
 589         void WriteMode(const char* modes, int flags, const char* text, ...);
 590
 591         /** Return true if a channel name is valid
 592          * @param chname A channel name to verify
 593          * @return True if the name is valid
 594          */
 595         bool IsChannel(const char *chname);
 596
 597         /** Rehash the local server
 598          * @param status This value is unused, and required for signal handler functions
 599          */
 600         static void Rehash(int status);
 601
 602         /** Causes the server to exit immediately
 603          * @param The exit code to give to the operating system
 604          */
 605         static void Exit(int status);
 606
 607         /** Return a count of users, unknown and known connections
 608          * @return The number of users
 609          */
 610         int UserCount();
 611
 612         /** Return a count of fully registered connections only
 613          * @return The number of registered users
 614          */
 615         int RegisteredUserCount();
 616
 617         /** Return a count of invisible (umode +i) users only
 618          * @return The number of invisible users
 619          */
 620         int InvisibleUserCount();
 621
 622         /** Return a count of opered (umode +o) users only
 623          * @return The number of opers
 624          */
 625         int OperCount();
 626
 627         /** Return a count of unregistered (before NICK/USER) users only
 628          * @return The number of unregistered (unknown) connections
 629          */
 630         int UnregisteredUserCount();
 631
 632         /** Return a count of channels on the network
 633          * @return The number of channels
 634          */
 635         long ChannelCount();
 636
 637         /** Return a count of local users on this server only
 638          * @return The number of local users
 639          */
 640         long LocalUserCount();
 641
 642         /** Send an error notice to all local users, opered and unopered
 643          * @param s The error string to send
 644          */
 645         void SendError(const char *s);
 646
 647         /** For use with Module::Prioritize().
 648          * When the return value of this function is returned from
 649          * Module::Prioritize(), this specifies that the module wishes
 650          * to be ordered exactly BEFORE 'modulename'. For more information
 651          * please see Module::Prioritize().
 652          * @param modulename The module your module wants to be before in the call list
 653          * @returns a priority ID which the core uses to relocate the module in the list
 654          */
 655         long PriorityBefore(const std::string &modulename);
 656
 657         /** For use with Module::Prioritize().
 658          * When the return value of this function is returned from
 659          * Module::Prioritize(), this specifies that the module wishes
 660          * to be ordered exactly AFTER 'modulename'. For more information please
 661          * see Module::Prioritize().
 662          * @param modulename The module your module wants to be after in the call list
 663          * @returns a priority ID which the core uses to relocate the module in the list
 664          */
 665         long PriorityAfter(const std::string &modulename);
 666
 667         /** Publish a 'feature'.
 668          * There are two ways for a module to find another module it depends on.
 669          * Either by name, using InspIRCd::FindModule, or by feature, using this
 670          * function. A feature is an arbitary string which identifies something this
 671          * module can do. For example, if your module provides SSL support, but other
 672          * modules provide SSL support too, all the modules supporting SSL should
 673          * publish an identical 'SSL' feature. This way, any module requiring use
 674          * of SSL functions can just look up the 'SSL' feature using FindFeature,
 675          * then use the module pointer they are given.
 676          * @param FeatureName The case sensitive feature name to make available
 677          * @param Mod a pointer to your module class
 678          * @returns True on success, false if the feature is already published by
 679          * another module.
 680          */
 681         bool PublishFeature(const std::string &FeatureName, Module* Mod);
 682
 683         /** Unpublish a 'feature'.
 684          * When your module exits, it must call this method for every feature it
 685          * is providing so that the feature table is cleaned up.
 686          * @param FeatureName the feature to remove
 687          */
 688         bool UnpublishFeature(const std::string &FeatureName);
 689
 690         /** Find a 'feature'.
 691          * There are two ways for a module to find another module it depends on.
 692          * Either by name, using InspIRCd::FindModule, or by feature, using the
 693          * InspIRCd::PublishFeature method. A feature is an arbitary string which
 694          * identifies something this module can do. For example, if your module
 695          * provides SSL support, but other modules provide SSL support too, all
 696          * the modules supporting SSL should publish an identical 'SSL' feature.
 697          * To find a module capable of providing the feature you want, simply
 698          * call this method with the feature name you are looking for.
 699          * @param FeatureName The feature name you wish to obtain the module for
 700          * @returns A pointer to a valid module class on success, NULL on failure.
 701          */
 702         Module* FindFeature(const std::string &FeatureName);
 703
 704         /** Given a pointer to a Module, return its filename
 705          * @param m The module pointer to identify
 706          * @return The module name or an empty string
 707          */
 708         const std::string& GetModuleName(Module* m);
 709
 710         /** Return true if a nickname is valid
 711          * @param n A nickname to verify
 712          * @return True if the nick is valid
 713          */
 714         bool IsNick(const char* n);
 715
 716         /** Return true if an ident is valid
 717          * @param An ident to verify
 718          * @return True if the ident is valid
 719          */
 720         bool IsIdent(const char* n);
 721
 722         /** Find a username by their file descriptor.
 723          * It is preferred to use this over directly accessing the fd_ref_table array.
 724          * @param socket The file descriptor of a user
 725          * @return A pointer to the user if the user exists locally on this descriptor
 726          */
 727         userrec* FindDescriptor(int socket);
 728
 729         /** Add a new mode to this server's mode parser
 730          * @param mh The modehandler to add
 731          * @param modechar The mode character this modehandler handles
 732          * @return True if the mode handler was added
 733          */
 734         bool AddMode(ModeHandler* mh, const unsigned char modechar);
 735
 736         /** Add a new mode watcher to this server's mode parser
 737          * @param mw The modewatcher to add
 738          * @return True if the modewatcher was added
 739          */
 740         bool AddModeWatcher(ModeWatcher* mw);
 741
 742         /** Delete a mode watcher from this server's mode parser
 743          * @param mw The modewatcher to delete
 744          * @return True if the modewatcher was deleted
 745          */
 746         bool DelModeWatcher(ModeWatcher* mw);
 747
 748         /** Add a dns Resolver class to this server's active set
 749          * @param r The resolver to add
 750          * @return True if the resolver was added
 751          */
 752         bool AddResolver(Resolver* r);
 753
 754         /** Add a command to this server's command parser
 755          * @param f A command_t command handler object to add
 756          * @throw ModuleException Will throw ModuleExcption if the command already exists
 757          */
 758         void AddCommand(command_t *f);
 759
 760         /** Send a modechange.
 761          * The parameters provided are identical to that sent to the
 762          * handler for class cmd_mode.
 763          * @param parameters The mode parameters
 764          * @param pcnt The number of items you have given in the first parameter
 765          * @param user The user to send error messages to
 766          */
 767         void SendMode(const char **parameters, int pcnt, userrec *user);
 768
 769         /** Match two strings using pattern matching.
 770          * This operates identically to the global function match(),
 771          * except for that it takes std::string arguments rather than
 772          * const char* ones.
 773          * @param sliteral The literal string to match against
 774          * @param spattern The pattern to match against. CIDR and globs are supported.
 775          */
 776         bool MatchText(const std::string &sliteral, const std::string &spattern);
 777
 778         /** Call the handler for a given command.
 779          * @param commandname The command whos handler you wish to call
 780          * @param parameters The mode parameters
 781          * @param pcnt The number of items you have given in the first parameter
 782          * @param user The user to execute the command as
 783          * @return True if the command handler was called successfully
 784          */
 785         bool CallCommandHandler(const std::string &commandname, const char** parameters, int pcnt, userrec* user);
 786
 787         /** Return true if the command is a module-implemented command and the given parameters are valid for it
 788          * @param parameters The mode parameters
 789          * @param pcnt The number of items you have given in the first parameter
 790          * @param user The user to test-execute the command as
 791          * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
 792          */
 793         bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
 794
 795         /** Add a gline and apply it
 796          * @param duration How long the line should last
 797          * @param source Who set the line
 798          * @param reason The reason for the line
 799          * @param hostmask The hostmask to set the line against
 800          */
 801         void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
 802
 803         /** Add a qline and apply it
 804          * @param duration How long the line should last
 805          * @param source Who set the line
 806          * @param reason The reason for the line
 807          * @param nickname The nickmask to set the line against
 808          */
 809         void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
 810
 811         /** Add a zline and apply it
 812          * @param duration How long the line should last
 813          * @param source Who set the line
 814          * @param reason The reason for the line
 815          * @param ipaddr The ip-mask to set the line against
 816          */
 817         void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
 818
 819         /** Add a kline and apply it
 820          * @param duration How long the line should last
 821          * @param source Who set the line
 822          * @param reason The reason for the line
 823          * @param hostmask The hostmask to set the line against
 824          */
 825         void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
 826
 827         /** Add an eline
 828          * @param duration How long the line should last
 829          * @param source Who set the line
 830          * @param reason The reason for the line
 831          * @param hostmask The hostmask to set the line against
 832          */
 833         void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
 834
 835         /** Delete a gline
 836          * @param hostmask The gline to delete
 837          * @return True if the item was removed
 838          */
 839         bool DelGLine(const std::string &hostmask);
 840
 841         /** Delete a qline
 842          * @param nickname The qline to delete
 843          * @return True if the item was removed
 844          */
 845         bool DelQLine(const std::string &nickname);
 846
 847         /** Delete a zline
 848          * @param ipaddr The zline to delete
 849          * @return True if the item was removed
 850          */
 851         bool DelZLine(const std::string &ipaddr);
 852
 853         /** Delete a kline
 854          * @param hostmask The kline to delete
 855          * @return True if the item was removed
 856          */
 857         bool DelKLine(const std::string &hostmask);
 858
 859         /** Delete an eline
 860          * @param hostmask The kline to delete
 861          * @return True if the item was removed
 862          */
 863         bool DelELine(const std::string &hostmask);
 864
 865         /** Return true if the given parameter is a valid nick!user\@host mask
 866          * @param mask A nick!user\@host masak to match against
 867          * @return True i the mask is valid
 868          */
 869         bool IsValidMask(const std::string &mask);
 870
 871         /** Add an InspSocket class to the active set
 872          * @param sock A socket to add to the active set
 873          */
 874         void AddSocket(InspSocket* sock);
 875
 876         /** Remove an InspSocket class from the active set at next time around the loop
 877          * @param sock A socket to remove from the active set
 878          */
 879         void RemoveSocket(InspSocket* sock);
 880
 881         /** Delete a socket immediately without waiting for the next iteration of the mainloop
 882          * @param sock A socket to delete from the active set
 883          */
 884         void DelSocket(InspSocket* sock);
 885
 886         /** Rehash the local server
 887          */
 888         void RehashServer();
 889
 890         /** Return the channel whos index number matches that provided
 891          * @param The index number of the channel to fetch
 892          * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
 893          */
 894         chanrec* GetChannelIndex(long index);
 895
 896         /** Dump text to a user target, splitting it appropriately to fit
 897          * @param User the user to dump the text to
 898          * @param LinePrefix text to prefix each complete line with
 899          * @param TextStream the text to send to the user
 900          */
 901         void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);
 902
 903         /** Check if the given nickmask matches too many users, send errors to the given user
 904          * @param nick A nickmask to match against
 905          * @param user A user to send error text to
 906          * @return True if the nick matches too many users
 907          */
 908         bool NickMatchesEveryone(const std::string &nick, userrec* user);
 909
 910         /** Check if the given IP mask matches too many users, send errors to the given user
 911          * @param ip An ipmask to match against
 912          * @param user A user to send error text to
 913          * @return True if the ip matches too many users
 914          */
 915         bool IPMatchesEveryone(const std::string &ip, userrec* user);
 916
 917         /** Check if the given hostmask matches too many users, send errors to the given user
 918          * @param mask A hostmask to match against
 919          * @param user A user to send error text to
 920          * @return True if the host matches too many users
 921          */
 922         bool HostMatchesEveryone(const std::string &mask, userrec* user);
 923
 924         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 925          * @param str A string containing a time in the form 1y2w3d4h6m5s
 926          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 927          * @return The total number of seconds
 928          */
 929         long Duration(const char* str);
 930
 931         /** Attempt to compare an oper password to a string from the config file.
 932          * This will be passed to handling modules which will compare the data
 933          * against possible hashed equivalents in the input string.
 934          * @param data The data from the config file
 935          * @param input The data input by the oper
 936          * @return 0 if the strings match, 1 or -1 if they do not
 937          */
 938         int OperPassCompare(const char* data,const char* input);
 939
 940         /** Check if a given server is a uline.
 941          * An empty string returns true, this is by design.
 942          * @param server The server to check for uline status
 943          * @return True if the server is a uline OR the string is empty
 944          */
 945         bool ULine(const char* server);
 946
 947         /** Returns the subversion revision ID of this ircd
 948          * @return The revision ID or an empty string
 949          */
 950         std::string GetRevision();
 951
 952         /** Returns the full version string of this ircd
 953          * @return The version string
 954          */
 955         std::string GetVersionString();
 956
 957         /** Attempt to write the process id to a given file
 958          * @param filename The PID file to attempt to write to
 959          * @return This function may bail if the file cannot be written
 960          */
 961         void WritePID(const std::string &filename);
 962
 963         /** Returns text describing the last module error
 964          * @return The last error message to occur
 965          */
 966         char* ModuleError();
 967
 968         /** Load a given module file
 969          * @param filename The file to load
 970          * @return True if the module was found and loaded
 971          */
 972         bool LoadModule(const char* filename);
 973
 974         /** Unload a given module file
 975          * @param filename The file to unload
 976          * @return True if the module was unloaded
 977          */
 978         bool UnloadModule(const char* filename);
 979
 980         /** This constructor initialises all the subsystems and reads the config file.
 981          * @param argc The argument count passed to main()
 982          * @param argv The argument list passed to main()
 983          * @throw <anything> If anything is thrown from here and makes it to
 984          * you, you should probably just give up and go home. Yes, really.
 985          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 986          */
 987         InspIRCd(int argc, char** argv);
 988
 989         /** Do one iteration of the mainloop
 990          * @param process_module_sockets True if module sockets are to be processed
 991          * this time around the event loop. The is the default.
 992          */
 993         void DoOneIteration(bool process_module_sockets = true);
 994
 995         /** Output a log message to the ircd.log file
 996          * The text will only be output if the current loglevel
 997          * is less than or equal to the level you provide
 998          * @param level A log level from the DebugLevel enum
 999          * @param text Format string of to write to the log
1000          * @param ... Format arguments of text to write to the log
1001          */
1002         void Log(int level, const char* text, ...);
1003
1004         /** Output a log message to the ircd.log file
1005          * The text will only be output if the current loglevel
1006          * is less than or equal to the level you provide
1007          * @param level A log level from the DebugLevel enum
1008          * @param text Text to write to the log
1009          */
1010         void Log(int level, const std::string &text);
1011
1012         /** Begin execution of the server.
1013          * NOTE: this function NEVER returns. Internally,
1014          * after performing some initialisation routines,
1015          * it will repeatedly call DoOneIteration in a loop.
1016          * @return The return value for this function is undefined.
1017          */
1018         int Run();
1019 };
1020
1021 #endif
1022