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