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