include/inspircd.h

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