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