include/inspircd.h

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