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 #pragma once
  27
  28 #define _FILE_OFFSET_BITS 64
  29 #ifndef _LARGEFILE_SOURCE
  30 #define _LARGEFILE_SOURCE
  31 #endif
  32
  33 #ifndef _WIN32
  34 #define DllExport
  35 #define CoreExport
  36 #else
  37 #include "inspircd_win32wrapper.h"
  38 /** Windows defines these already */
  39 #undef ERROR
  40 #endif
  41
  42 #ifdef __GNUC__
  43 #define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
  44 #else
  45 #define CUSTOM_PRINTF(STRING, FIRST)
  46 #endif
  47
  48 #if defined __clang__ || defined __GNUC__
  49 # define DEPRECATED_METHOD(function) function __attribute__((deprecated))
  50 #elif defined _MSC_VER
  51 # define DEPRECATED_METHOD(function) __declspec(deprecated) function
  52 #else
  53 # pragma message ("Warning! DEPRECATED_METHOD() does not work on your compiler!")
  54 # define DEPRECATED_METHOD(function) function
  55 #endif
  56
  57 // Required system headers.
  58 #include <ctime>
  59 #include <cstdarg>
  60 #include <algorithm>
  61 #include <cmath>
  62 #include <cstring>
  63 #include <climits>
  64 #include <cstdio>
  65 #ifndef _WIN32
  66 #include <unistd.h>
  67 #endif
  68
  69 #ifdef _WIN32
  70 # include <unordered_map>
  71 #else
  72 # include <tr1/unordered_map>
  73 #endif
  74 #include <sstream>
  75 #include <string>
  76 #include <vector>
  77 #include <list>
  78 #include <deque>
  79 #include <map>
  80 #include <bitset>
  81 #include <set>
  82 #include <time.h>
  83 #include "config.h"
  84 #include "typedefs.h"
  85 #include "consolecolors.h"
  86
  87 CoreExport extern InspIRCd* ServerInstance;
  88
  89 #include "caller.h"
  90 #include "cull_list.h"
  91 #include "extensible.h"
  92 #include "numerics.h"
  93 #include "uid.h"
  94 #include "users.h"
  95 #include "channels.h"
  96 #include "timer.h"
  97 #include "hashcomp.h"
  98 #include "logger.h"
  99 #include "usermanager.h"
 100 #include "socket.h"
 101 #include "ctables.h"
 102 #include "command_parse.h"
 103 #include "mode.h"
 104 #include "socketengine.h"
 105 #include "snomasks.h"
 106 #include "filelogger.h"
 107 #include "modules.h"
 108 #include "threadengine.h"
 109 #include "configreader.h"
 110 #include "inspstring.h"
 111 #include "protocol.h"
 112
 113 #ifndef PATH_MAX
 114 #warning Potentially broken system, PATH_MAX undefined
 115 #define PATH_MAX 4096
 116 #endif
 117
 118 /**
 119  * Used to define the maximum number of parameters a command may have.
 120  */
 121 #define MAXPARAMETERS 127
 122
 123 /** Returned by some functions to indicate failure.
 124  */
 125 #define ERROR -1
 126
 127 /** Template function to convert any input type to std::string
 128  */
 129 template<typename T> inline std::string ConvNumeric(const T &in)
 130 {
 131         if (in == 0) return "0";
 132         char res[MAXBUF];
 133         char* out = res;
 134         T quotient = in;
 135         while (quotient) {
 136                 *out = "0123456789"[ std::abs( (long)quotient % 10 ) ];
 137                 ++out;
 138                 quotient /= 10;
 139         }
 140         if (in < 0)
 141                 *out++ = '-';
 142         *out = 0;
 143         std::reverse(res,out);
 144         return res;
 145 }
 146
 147 /** Template function to convert any input type to std::string
 148  */
 149 inline std::string ConvToStr(const int 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 long in)
 157 {
 158         return ConvNumeric(in);
 159 }
 160
 161 /** Template function to convert any input type to std::string
 162  */
 163 inline std::string ConvToStr(const char* in)
 164 {
 165         return in;
 166 }
 167
 168 /** Template function to convert any input type to std::string
 169  */
 170 inline std::string ConvToStr(const bool in)
 171 {
 172         return (in ? "1" : "0");
 173 }
 174
 175 /** Template function to convert any input type to std::string
 176  */
 177 inline std::string ConvToStr(char in)
 178 {
 179         return std::string(in,1);
 180 }
 181
 182 /** Template function to convert any input type to std::string
 183  */
 184 template <class T> inline std::string ConvToStr(const T &in)
 185 {
 186         std::stringstream tmp;
 187         if (!(tmp << in)) return std::string();
 188         return tmp.str();
 189 }
 190
 191 /** Template function to convert any input type to any other type
 192  * (usually an integer or numeric type)
 193  */
 194 template<typename T> inline long ConvToInt(const T &in)
 195 {
 196         std::stringstream tmp;
 197         if (!(tmp << in)) return 0;
 198         return atol(tmp.str().c_str());
 199 }
 200
 201 /** This class contains various STATS counters
 202  * It is used by the InspIRCd class, which internally
 203  * has an instance of it.
 204  */
 205 class serverstats
 206 {
 207   public:
 208         /** Number of accepted connections
 209          */
 210         unsigned long statsAccept;
 211         /** Number of failed accepts
 212          */
 213         unsigned long statsRefused;
 214         /** Number of unknown commands seen
 215          */
 216         unsigned long statsUnknown;
 217         /** Number of nickname collisions handled
 218          */
 219         unsigned long statsCollisions;
 220         /** Number of DNS queries sent out
 221          */
 222         unsigned long statsDns;
 223         /** Number of good DNS replies received
 224          * NOTE: This may not tally to the number sent out,
 225          * due to timeouts and other latency issues.
 226          */
 227         unsigned long statsDnsGood;
 228         /** Number of bad (negative) DNS replies received
 229          * NOTE: This may not tally to the number sent out,
 230          * due to timeouts and other latency issues.
 231          */
 232         unsigned long statsDnsBad;
 233         /** Number of inbound connections seen
 234          */
 235         unsigned long statsConnects;
 236         /** Total bytes of data transmitted
 237          */
 238         unsigned long statsSent;
 239         /** Total bytes of data received
 240          */
 241         unsigned long statsRecv;
 242 #ifdef _WIN32
 243         /** Cpu usage at last sample
 244         */
 245         FILETIME LastCPU;
 246         /** Time QP sample was read
 247         */
 248         LARGE_INTEGER LastSampled;
 249         /** QP frequency
 250         */
 251         LARGE_INTEGER QPFrequency;
 252 #else
 253         /** Cpu usage at last sample
 254          */
 255         timeval LastCPU;
 256         /** Time last sample was read
 257          */
 258         timespec LastSampled;
 259 #endif
 260         /** The constructor initializes all the counts to zero
 261          */
 262         serverstats()
 263                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
 264                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
 265         {
 266         }
 267 };
 268
 269 /** This class manages the generation and transmission of ISUPPORT. */
 270 class CoreExport ISupportManager
 271 {
 272 private:
 273         /** The generated lines which are sent to clients. */
 274         std::vector<std::string> Lines;
 275
 276 public:
 277         /** (Re)build the ISUPPORT vector. */
 278         void Build();
 279
 280         /** Returns the std::vector of ISUPPORT lines. */
 281         const std::vector<std::string>& GetLines()
 282         {
 283                 return this->Lines;
 284         }
 285
 286         /** Send the 005 numerics (ISUPPORT) to a user. */
 287         void SendTo(LocalUser* user);
 288 };
 289
 290 DEFINE_HANDLER2(IsNickHandler, bool, const std::string&, size_t);
 291 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 292 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
 293 DEFINE_HANDLER2(IsChannelHandler, bool, const std::string&, size_t);
 294 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 295 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 296
 297 class TestSuite;
 298
 299 /** The main class of the irc server.
 300  * This class contains instances of all the other classes in this software.
 301  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 302  * object, and a list of active Module objects, and facilities for Module
 303  * objects to interact with the core system it implements.
 304  */
 305 class CoreExport InspIRCd
 306 {
 307  private:
 308         /** Holds the current UID. Used to generate the next one.
 309          */
 310         char current_uid[UUID_LENGTH];
 311
 312         /** Set up the signal handlers
 313          */
 314         void SetSignals();
 315
 316         /** Daemonize the ircd and close standard input/output streams
 317          * @return True if the program daemonized succesfully
 318          */
 319         bool DaemonSeed();
 320
 321         /** Iterate the list of BufferedSocket objects, removing ones which have timed out
 322          * @param TIME the current time
 323          */
 324         void DoSocketTimeouts(time_t TIME);
 325
 326         /** Increments the current UID by one.
 327          */
 328         void IncrementUID(int pos);
 329
 330         /** Perform background user events such as PING checks
 331          */
 332         void DoBackgroundUserStuff();
 333
 334         /** Returns true when all modules have done pre-registration checks on a user
 335          * @param user The user to verify
 336          * @return True if all modules have finished checking this user
 337          */
 338         bool AllModulesReportReady(LocalUser* user);
 339
 340         /** The current time, updated in the mainloop
 341          */
 342         struct timespec TIME;
 343
 344         /** A 64k buffer used to read socket data into
 345          * NOTE: update ValidateNetBufferSize if you change this
 346          */
 347         char ReadBuffer[65535];
 348
 349  public:
 350
 351         /** Global cull list, will be processed on next iteration
 352          */
 353         CullList GlobalCulls;
 354         /** Actions that must happen outside of the current call stack */
 355         ActionList AtomicActions;
 356
 357         /**** Functors ****/
 358
 359         IsNickHandler HandleIsNick;
 360         IsIdentHandler HandleIsIdent;
 361         OnCheckExemptionHandler HandleOnCheckExemption;
 362         IsChannelHandler HandleIsChannel;
 363         RehashHandler HandleRehash;
 364         GenRandomHandler HandleGenRandom;
 365
 366         /** 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
 367          * Reason for it:
 368          * kludge alert!
 369          * SendMode expects a User* to send the numeric replies
 370          * back to, so we create it a fake user that isnt in the user
 371          * hash and set its descriptor to FD_MAGIC_NUMBER so the data
 372          * falls into the abyss :p
 373          */
 374         FakeUser* FakeClient;
 375
 376         /** Returns the next available UID for this server.
 377          */
 378         std::string GetUID();
 379
 380         static const char LogHeader[];
 381
 382         /** Find a user in the UUID hash
 383          * @param uid The UUID to find
 384          * @return A pointer to the user, or NULL if the user does not exist
 385          */
 386         User* FindUUID(const std::string &uid);
 387
 388         /** Time this ircd was booted
 389          */
 390         time_t startup_time;
 391
 392         /** Config file pathname specified on the commandline or via ./configure
 393          */
 394         std::string ConfigFileName;
 395
 396         ExtensionManager Extensions;
 397
 398         /** Mode handler, handles mode setting and removal
 399          */
 400         ModeParser* Modes;
 401
 402         /** Command parser, handles client to server commands
 403          */
 404         CommandParser* Parser;
 405
 406         /** Socket engine, handles socket activity events
 407          */
 408         SocketEngine* SE;
 409
 410         /** Thread engine, Handles threading where required
 411          */
 412         ThreadEngine* Threads;
 413
 414         /** The thread/class used to read config files in REHASH and on startup
 415          */
 416         ConfigReaderThread* ConfigThread;
 417
 418         /** LogManager handles logging.
 419          */
 420         LogManager *Logs;
 421
 422         /** ModuleManager contains everything related to loading/unloading
 423          * modules.
 424          */
 425         ModuleManager* Modules;
 426
 427         /** BanCacheManager is used to speed up checking of restrictions on connection
 428          * to the IRCd.
 429          */
 430         BanCacheManager *BanCache;
 431
 432         /** Stats class, holds miscellaneous stats counters
 433          */
 434         serverstats* stats;
 435
 436         /**  Server Config class, holds configuration file data
 437          */
 438         ServerConfig* Config;
 439
 440         /** Snomask manager - handles routing of snomask messages
 441          * to opers.
 442          */
 443         SnomaskManager* SNO;
 444
 445         /** DNS class, provides resolver facilities to the core and modules
 446          */
 447         DNS* Res;
 448
 449         /** Timer manager class, triggers Timer timer events
 450          */
 451         TimerManager* Timers;
 452
 453         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 454          */
 455         XLineManager* XLines;
 456
 457         /** User manager. Various methods and data associated with users.
 458          */
 459         UserManager *Users;
 460
 461         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 462          */
 463         chan_hash* chanlist;
 464
 465         /** List of the open ports
 466          */
 467         std::vector<ListenSocket*> ports;
 468
 469         /** Set to the current signal recieved
 470          */
 471         int s_signal;
 472
 473         /** Protocol interface, overridden by server protocol modules
 474          */
 475         ProtocolInterface* PI;
 476
 477         /** Holds extensible for user nickforced
 478          */
 479         LocalIntExt NICKForced;
 480
 481         /** Holds extensible for user operquit
 482          */
 483         LocalStringExt OperQuit;
 484
 485         /** Manages the generation and transmission of ISUPPORT. */
 486         ISupportManager ISupport;
 487
 488         /** Get the current time
 489          * Because this only calls time() once every time around the mainloop,
 490          * it is much faster than calling time() directly.
 491          * @return The current time as an epoch value (time_t)
 492          */
 493         inline time_t Time() { return TIME.tv_sec; }
 494         /** The fractional time at the start of this mainloop iteration (nanoseconds) */
 495         inline long Time_ns() { return TIME.tv_nsec; }
 496         /** Update the current time. Don't call this unless you have reason to do so. */
 497         void UpdateTime();
 498
 499         /** Generate a random string with the given length
 500          * @param length The length in bytes
 501          * @param printable if false, the string will use characters 0-255; otherwise,
 502          * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
 503          */
 504         std::string GenRandomStr(int length, bool printable = true);
 505         /** Generate a random integer.
 506          * This is generally more secure than rand()
 507          */
 508         unsigned long GenRandomInt(unsigned long max);
 509
 510         /** Fill a buffer with random bits */
 511         caller2<void, char*, size_t> GenRandom;
 512
 513         /** Bind all ports specified in the configuration file.
 514          * @return The number of ports bound without error
 515          */
 516         int BindPorts(FailedPortList &failed_ports);
 517
 518         /** Binds a socket on an already open file descriptor
 519          * @param sockfd A valid file descriptor of an open socket
 520          * @param port The port number to bind to
 521          * @param addr The address to bind to (IP only)
 522          * @param dolisten Should this port be listened on?
 523          * @return True if the port was bound successfully
 524          */
 525         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
 526
 527         /** Gets the GECOS (description) field of the given server.
 528          * If the servername is not that of the local server, the name
 529          * is passed to handling modules which will attempt to determine
 530          * the GECOS that bleongs to the given servername.
 531          * @param servername The servername to find the description of
 532          * @return The description of this server, or of the local server
 533          */
 534         std::string GetServerDescription(const std::string& servername);
 535
 536         /** Find a user in the nick hash.
 537          * If the user cant be found in the nick hash check the uuid hash
 538          * @param nick The nickname to find
 539          * @return A pointer to the user, or NULL if the user does not exist
 540          */
 541         User* FindNick(const std::string &nick);
 542
 543         /** Find a user in the nick hash ONLY
 544          */
 545         User* FindNickOnly(const std::string &nick);
 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 std::string &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 std::string&, size_t> IsChannel;
 570
 571         /** Return true if str looks like a server ID
 572          * @param string to check against
 573          */
 574         static bool IsSID(const std::string& sid);
 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 std::string&, 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 std::string&> 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         /** Return true if the given parameter is a valid nick!user\@host mask
 688          * @param mask A nick!user\@host masak to match against
 689          * @return True i the mask is valid
 690          */
 691         bool IsValidMask(const std::string &mask);
 692
 693         /** Strips all color codes from the given string
 694          * @param sentence The string to strip from
 695          */
 696         static void StripColor(std::string &sentence);
 697
 698         /** Parses color codes from string values to actual color codes
 699          * @param input The data to process
 700          */
 701         static void ProcessColors(file_cache& input);
 702
 703         /** Rehash the local server
 704          */
 705         void RehashServer();
 706
 707         /** Check if the given nickmask matches too many users, send errors to the given user
 708          * @param nick A nickmask to match against
 709          * @param user A user to send error text to
 710          * @return True if the nick matches too many users
 711          */
 712         bool NickMatchesEveryone(const std::string &nick, User* user);
 713
 714         /** Check if the given IP mask matches too many users, send errors to the given user
 715          * @param ip An ipmask to match against
 716          * @param user A user to send error text to
 717          * @return True if the ip matches too many users
 718          */
 719         bool IPMatchesEveryone(const std::string &ip, User* user);
 720
 721         /** Check if the given hostmask matches too many users, send errors to the given user
 722          * @param mask A hostmask to match against
 723          * @param user A user to send error text to
 724          * @return True if the host matches too many users
 725          */
 726         bool HostMatchesEveryone(const std::string &mask, User* user);
 727
 728         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 729          * @param str A string containing a time in the form 1y2w3d4h6m5s
 730          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 731          * @return The total number of seconds
 732          */
 733         static unsigned long Duration(const std::string& str);
 734
 735         /** Attempt to compare a password to a string from the config file.
 736          * This will be passed to handling modules which will compare the data
 737          * against possible hashed equivalents in the input string.
 738          * @param ex The object (user, server, whatever) causing the comparison.
 739          * @param data The data from the config file
 740          * @param input The data input by the oper
 741          * @param hashtype The hash from the config file
 742          * @return 0 if the strings match, 1 or -1 if they do not
 743          */
 744         int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
 745
 746         /** Check if a given server is a uline.
 747          * An empty string returns true, this is by design.
 748          * @param server The server to check for uline status
 749          * @return True if the server is a uline OR the string is empty
 750          */
 751         bool ULine(const std::string& server);
 752
 753         /** Returns true if the uline is 'silent' (doesnt generate
 754          * remote connect notices etc).
 755          */
 756         bool SilentULine(const std::string& server);
 757
 758         /** Returns the full version string of this ircd
 759          * @return The version string
 760          */
 761         std::string GetVersionString(bool rawversion = false);
 762
 763         /** Attempt to write the process id to a given file
 764          * @param filename The PID file to attempt to write to
 765          * @return This function may bail if the file cannot be written
 766          */
 767         void WritePID(const std::string &filename);
 768
 769         /** This constructor initialises all the subsystems and reads the config file.
 770          * @param argc The argument count passed to main()
 771          * @param argv The argument list passed to main()
 772          * @throw <anything> If anything is thrown from here and makes it to
 773          * you, you should probably just give up and go home. Yes, really.
 774          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 775          */
 776         InspIRCd(int argc, char** argv);
 777
 778         /** Send a line of WHOIS data to a user.
 779          * @param user user to send the line to
 780          * @param dest user being WHOISed
 781          * @param numeric Numeric to send
 782          * @param text Text of the numeric
 783          */
 784         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 785
 786         /** Send a line of WHOIS data to a user.
 787          * @param user user to send the line to
 788          * @param dest user being WHOISed
 789          * @param numeric Numeric to send
 790          * @param format Format string for the numeric
 791          * @param ... Parameters for the format string
 792          */
 793         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 794
 795         /** Called to check whether a channel restriction mode applies to a user
 796          * @param User that is attempting some action
 797          * @param Channel that the action is being performed on
 798          * @param Action name
 799          */
 800         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 801
 802         /** Restart the server.
 803          * This function will not return. If an error occurs,
 804          * it will throw an instance of CoreException.
 805          * @param reason The restart reason to show to all clients
 806          * @throw CoreException An instance of CoreException indicating the error from execv().
 807          */
 808         void Restart(const std::string &reason);
 809
 810         /** Prepare the ircd for restart or shutdown.
 811          * This function unloads all modules which can be unloaded,
 812          * closes all open sockets, and closes the logfile.
 813          */
 814         void Cleanup();
 815
 816         /** Return a time_t as a human-readable string.
 817          */
 818         std::string TimeString(time_t curtime);
 819
 820         /** Begin execution of the server.
 821          * NOTE: this function NEVER returns. Internally,
 822          * it will repeatedly loop.
 823          * @return The return value for this function is undefined.
 824          */
 825         int Run();
 826
 827         char* GetReadBuffer()
 828         {
 829                 return this->ReadBuffer;
 830         }
 831
 832         friend class TestSuite;
 833 };
 834
 835 ENTRYPOINT;
 836
 837 template<class Cmd>
 838 class CommandModule : public Module
 839 {
 840         Cmd cmd;
 841  public:
 842         CommandModule() : cmd(this)
 843         {
 844         }
 845
 846         void init()
 847         {
 848                 ServerInstance->Modules->AddService(cmd);
 849         }
 850
 851         Version GetVersion()
 852         {
 853                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 854         }
 855 };