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 #include <climits>
  29 #include <cmath>
  30 #include <csignal>
  31 #include <cstdarg>
  32 #include <cstdio>
  33 #include <cstring>
  34 #include <ctime>
  35 #include <stdint.h>
  36
  37 #include <algorithm>
  38 #include <bitset>
  39 #include <deque>
  40 #include <list>
  41 #include <map>
  42 #include <set>
  43 #include <sstream>
  44 #include <string>
  45 #include <vector>
  46
  47 #include "intrusive_list.h"
  48 #include "flat_map.h"
  49 #include "compat.h"
  50 #include "aligned_storage.h"
  51 #include "typedefs.h"
  52 #include "stdalgo.h"
  53
  54 CoreExport extern InspIRCd* ServerInstance;
  55
  56 /** Base class for manager classes that are still accessed using -> but are no longer pointers
  57  */
  58 template <typename T>
  59 struct fakederef
  60 {
  61         T* operator->()
  62         {
  63                 return static_cast<T*>(this);
  64         }
  65 };
  66
  67 #include "config.h"
  68 #include "convto.h"
  69 #include "dynref.h"
  70 #include "consolecolors.h"
  71 #include "caller.h"
  72 #include "cull_list.h"
  73 #include "extensible.h"
  74 #include "fileutils.h"
  75 #include "numerics.h"
  76 #include "numeric.h"
  77 #include "uid.h"
  78 #include "server.h"
  79 #include "users.h"
  80 #include "channels.h"
  81 #include "timer.h"
  82 #include "hashcomp.h"
  83 #include "logger.h"
  84 #include "usermanager.h"
  85 #include "socket.h"
  86 #include "ctables.h"
  87 #include "command_parse.h"
  88 #include "mode.h"
  89 #include "socketengine.h"
  90 #include "snomasks.h"
  91 #include "filelogger.h"
  92 #include "modules.h"
  93 #include "threadengine.h"
  94 #include "configreader.h"
  95 #include "inspstring.h"
  96 #include "protocol.h"
  97 #include "bancache.h"
  98 #include "isupportmanager.h"
  99
 100 /** This class contains various STATS counters
 101  * It is used by the InspIRCd class, which internally
 102  * has an instance of it.
 103  */
 104 class serverstats
 105 {
 106   public:
 107         /** Number of accepted connections
 108          */
 109         unsigned long Accept;
 110         /** Number of failed accepts
 111          */
 112         unsigned long Refused;
 113         /** Number of unknown commands seen
 114          */
 115         unsigned long Unknown;
 116         /** Number of nickname collisions handled
 117          */
 118         unsigned long Collisions;
 119         /** Number of DNS queries sent out
 120          */
 121         unsigned long Dns;
 122         /** Number of good DNS replies received
 123          * NOTE: This may not tally to the number sent out,
 124          * due to timeouts and other latency issues.
 125          */
 126         unsigned long DnsGood;
 127         /** Number of bad (negative) DNS replies received
 128          * NOTE: This may not tally to the number sent out,
 129          * due to timeouts and other latency issues.
 130          */
 131         unsigned long DnsBad;
 132         /** Number of inbound connections seen
 133          */
 134         unsigned long Connects;
 135         /** Total bytes of data transmitted
 136          */
 137         unsigned long Sent;
 138         /** Total bytes of data received
 139          */
 140         unsigned long Recv;
 141 #ifdef _WIN32
 142         /** Cpu usage at last sample
 143         */
 144         FILETIME LastCPU;
 145         /** Time QP sample was read
 146         */
 147         LARGE_INTEGER LastSampled;
 148         /** QP frequency
 149         */
 150         LARGE_INTEGER QPFrequency;
 151 #else
 152         /** Cpu usage at last sample
 153          */
 154         timeval LastCPU;
 155         /** Time last sample was read
 156          */
 157         timespec LastSampled;
 158 #endif
 159         /** The constructor initializes all the counts to zero
 160          */
 161         serverstats()
 162                 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
 163                 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
 164         {
 165         }
 166 };
 167
 168 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 169 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
 170
 171 /** The main class of the irc server.
 172  * This class contains instances of all the other classes in this software.
 173  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 174  * object, and a list of active Module objects, and facilities for Module
 175  * objects to interact with the core system it implements.
 176  */
 177 class CoreExport InspIRCd
 178 {
 179  private:
 180         /** Set up the signal handlers
 181          */
 182         void SetSignals();
 183
 184         /** Daemonize the ircd and close standard input/output streams
 185          * @return True if the program daemonized succesfully
 186          */
 187         bool DaemonSeed();
 188
 189         /** The current time, updated in the mainloop
 190          */
 191         struct timespec TIME;
 192
 193         /** A 64k buffer used to read socket data into
 194          * NOTE: update ValidateNetBufferSize if you change this
 195          */
 196         char ReadBuffer[65535];
 197
 198         /** Check we aren't running as root, and exit if we are
 199          * with exit code EXIT_STATUS_ROOT.
 200          */
 201         void CheckRoot();
 202
 203  public:
 204
 205         UIDGenerator UIDGen;
 206
 207         /** Global cull list, will be processed on next iteration
 208          */
 209         CullList GlobalCulls;
 210         /** Actions that must happen outside of the current call stack */
 211         ActionList AtomicActions;
 212
 213         /**** Functors ****/
 214         IsChannelHandler HandleIsChannel;
 215         GenRandomHandler HandleGenRandom;
 216
 217         /** 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
 218          * Reason for it:
 219          * kludge alert!
 220          * SendMode expects a User* to send the numeric replies
 221          * back to, so we create it a fake user that isnt in the user
 222          * hash and set its descriptor to FD_MAGIC_NUMBER so the data
 223          * falls into the abyss :p
 224          */
 225         FakeUser* FakeClient;
 226
 227         /** Find a user in the UUID hash
 228          * @param uid The UUID to find
 229          * @return A pointer to the user, or NULL if the user does not exist
 230          */
 231         User* FindUUID(const std::string &uid);
 232
 233         /** Time this ircd was booted
 234          */
 235         time_t startup_time;
 236
 237         /** Config file pathname specified on the commandline or via ./configure
 238          */
 239         std::string ConfigFileName;
 240
 241         ExtensionManager Extensions;
 242
 243         /** Mode handler, handles mode setting and removal
 244          */
 245         ModeParser Modes;
 246
 247         /** Command parser, handles client to server commands
 248          */
 249         CommandParser Parser;
 250
 251         /** Thread engine, Handles threading where required
 252          */
 253         ThreadEngine Threads;
 254
 255         /** The thread/class used to read config files in REHASH and on startup
 256          */
 257         ConfigReaderThread* ConfigThread;
 258
 259         /** LogManager handles logging.
 260          */
 261         LogManager Logs;
 262
 263         /** ModuleManager contains everything related to loading/unloading
 264          * modules.
 265          */
 266         ModuleManager Modules;
 267
 268         /** BanCacheManager is used to speed up checking of restrictions on connection
 269          * to the IRCd.
 270          */
 271         BanCacheManager BanCache;
 272
 273         /** Stats class, holds miscellaneous stats counters
 274          */
 275         serverstats stats;
 276
 277         /**  Server Config class, holds configuration file data
 278          */
 279         ServerConfig* Config;
 280
 281         /** Snomask manager - handles routing of snomask messages
 282          * to opers.
 283          */
 284         SnomaskManager SNO;
 285
 286         /** Timer manager class, triggers Timer timer events
 287          */
 288         TimerManager Timers;
 289
 290         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 291          */
 292         XLineManager* XLines;
 293
 294         /** User manager. Various methods and data associated with users.
 295          */
 296         UserManager Users;
 297
 298         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 299          */
 300         chan_hash chanlist;
 301
 302         /** List of the open ports
 303          */
 304         std::vector<ListenSocket*> ports;
 305
 306         /** Set to the current signal recieved
 307          */
 308         static sig_atomic_t s_signal;
 309
 310         /** Protocol interface, overridden by server protocol modules
 311          */
 312         ProtocolInterface* PI;
 313
 314         /** Default implementation of the ProtocolInterface, does nothing
 315          */
 316         ProtocolInterface DefaultProtocolInterface;
 317
 318         /** Manages the generation and transmission of ISUPPORT. */
 319         ISupportManager ISupport;
 320
 321         /** Get the current time
 322          * Because this only calls time() once every time around the mainloop,
 323          * it is much faster than calling time() directly.
 324          * @return The current time as an epoch value (time_t)
 325          */
 326         inline time_t Time() { return TIME.tv_sec; }
 327         /** The fractional time at the start of this mainloop iteration (nanoseconds) */
 328         inline long Time_ns() { return TIME.tv_nsec; }
 329         /** Update the current time. Don't call this unless you have reason to do so. */
 330         void UpdateTime();
 331
 332         /** Generate a random string with the given length
 333          * @param length The length in bytes
 334          * @param printable if false, the string will use characters 0-255; otherwise,
 335          * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
 336          */
 337         std::string GenRandomStr(unsigned int length, bool printable = true);
 338         /** Generate a random integer.
 339          * This is generally more secure than rand()
 340          */
 341         unsigned long GenRandomInt(unsigned long max);
 342
 343         /** Fill a buffer with random bits */
 344         caller2<void, char*, size_t> GenRandom;
 345
 346         /** Bind all ports specified in the configuration file.
 347          * @return The number of ports bound without error
 348          */
 349         int BindPorts(FailedPortList &failed_ports);
 350
 351         /** Find a user in the nick hash.
 352          * If the user cant be found in the nick hash check the uuid hash
 353          * @param nick The nickname to find
 354          * @return A pointer to the user, or NULL if the user does not exist
 355          */
 356         User* FindNick(const std::string &nick);
 357
 358         /** Find a user in the nick hash ONLY
 359          */
 360         User* FindNickOnly(const std::string &nick);
 361
 362         /** Find a channel in the channels hash
 363          * @param chan The channel to find
 364          * @return A pointer to the channel, or NULL if the channel does not exist
 365          */
 366         Channel* FindChan(const std::string &chan);
 367
 368         /** Get a hash map containing all channels, keyed by their name
 369          * @return A hash map mapping channel names to Channel pointers
 370          */
 371         chan_hash& GetChans() { return chanlist; }
 372
 373         /** Return true if a channel name is valid
 374          * @param chname A channel name to verify
 375          * @return True if the name is valid
 376          */
 377         caller1<bool, const std::string&> IsChannel;
 378
 379         /** Return true if str looks like a server ID
 380          * @param sid string to check against
 381          */
 382         static bool IsSID(const std::string& sid);
 383
 384         /** Handles incoming signals after being set
 385          * @param signal the signal recieved
 386          */
 387         void SignalHandler(int signal);
 388
 389         /** Sets the signal recieved
 390          * @param signal the signal recieved
 391          */
 392         static void SetSignal(int signal);
 393
 394         /** Causes the server to exit after unloading modules and
 395          * closing all open file descriptors.
 396          *
 397          * @param status The exit code to give to the operating system
 398          * (See the ExitStatus enum for valid values)
 399          */
 400         void Exit(int status);
 401
 402         /** Causes the server to exit immediately with exit code 0.
 403          * The status code is required for signal handlers, and ignored.
 404          */
 405         static void QuickExit(int status);
 406
 407         /** Formats the input string with the specified arguments.
 408         * @param formatString The string to format
 409         * @param ... A variable number of format arguments.
 410         * @return The formatted string
 411         */
 412         static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
 413         static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 414
 415         /** Determines whether a nickname is valid. */
 416         TR1NS::function<bool(const std::string&)> IsNick;
 417
 418         /** Determines whether a nickname is valid according to the RFC 1459 rules.
 419          * This is the default function for InspIRCd::IsNick.
 420          * @param nick The nickname to validate.
 421          * @return True if the nickname is valid according to RFC 1459 rules; otherwise, false.
 422          */
 423         static bool DefaultIsNick(const std::string& nick);
 424
 425         /** Determines whether an ident is valid. */
 426         TR1NS::function<bool(const std::string&)> IsIdent;
 427
 428         /** Determines whether a ident is valid according to the RFC 1459 rules.
 429          * This is the default function for InspIRCd::IsIdent.
 430          * @param nick The ident to validate.
 431          * @return True if the ident is valid according to RFC 1459 rules; otherwise, false.
 432         */
 433         static bool DefaultIsIdent(const std::string& ident);
 434
 435         /** Match two strings using pattern matching, optionally, with a map
 436          * to check case against (may be NULL). If map is null, match will be case insensitive.
 437          * @param str The literal string to match against
 438          * @param mask The glob pattern to match against.
 439          * @param map The character map to use when matching.
 440          */
 441         static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
 442         static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
 443
 444         /** Match two strings using pattern matching, optionally, with a map
 445          * to check case against (may be NULL). If map is null, match will be case insensitive.
 446          * Supports CIDR patterns as well as globs.
 447          * @param str The literal string to match against
 448          * @param mask The glob or CIDR pattern to match against.
 449          * @param map The character map to use when matching.
 450          */
 451         static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
 452         static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
 453
 454         /** Matches a hostname and IP against a space delimited list of hostmasks.
 455          * @param masks The space delimited masks to match against.
 456          * @param hostname The hostname to try and match.
 457          * @param ipaddr The IP address to try and match.
 458          */
 459         static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 460
 461         /** Return true if the given parameter is a valid nick!user\@host mask
 462          * @param mask A nick!user\@host masak to match against
 463          * @return True i the mask is valid
 464          */
 465         static bool IsValidMask(const std::string& mask);
 466
 467         /** Strips all color and control codes except 001 from the given string
 468          * @param sentence The string to strip from
 469          */
 470         static void StripColor(std::string &sentence);
 471
 472         /** Parses color codes from string values to actual color codes
 473          * @param input The data to process
 474          */
 475         static void ProcessColors(file_cache& input);
 476
 477         /** Rehash the local server
 478          * @param uuid The uuid of the user who started the rehash, can be empty
 479          */
 480         void Rehash(const std::string& uuid = "");
 481
 482         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 483          * @param str A string containing a time in the form 1y2w3d4h6m5s
 484          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 485          * @return The total number of seconds
 486          */
 487         static unsigned long Duration(const std::string& str);
 488
 489         /** Attempt to compare a password to a string from the config file.
 490          * This will be passed to handling modules which will compare the data
 491          * against possible hashed equivalents in the input string.
 492          * @param ex The object (user, server, whatever) causing the comparison.
 493          * @param data The data from the config file
 494          * @param input The data input by the oper
 495          * @param hashtype The hash from the config file
 496          * @return True if the strings match, false if they do not
 497          */
 498         bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
 499
 500         /** Returns the full version string of this ircd
 501          * @return The version string
 502          */
 503         std::string GetVersionString(bool getFullVersion = false);
 504
 505         /** Attempt to write the process id to a given file
 506          * @param filename The PID file to attempt to write to
 507          * @param exitonfail If true and the PID fail cannot be written log to stdout and exit, otherwise only log on failure
 508          * @return This function may bail if the file cannot be written
 509          */
 510         void WritePID(const std::string& filename, bool exitonfail = true);
 511
 512         /** This constructor initialises all the subsystems and reads the config file.
 513          * @param argc The argument count passed to main()
 514          * @param argv The argument list passed to main()
 515          * @throw <anything> If anything is thrown from here and makes it to
 516          * you, you should probably just give up and go home. Yes, really.
 517          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 518          */
 519         InspIRCd(int argc, char** argv);
 520
 521         /** Prepare the ircd for restart or shutdown.
 522          * This function unloads all modules which can be unloaded,
 523          * closes all open sockets, and closes the logfile.
 524          */
 525         void Cleanup();
 526
 527         /** Return a time_t as a human-readable string.
 528          * @param format The format to retrieve the date/time in. See `man 3 strftime`
 529          * for more information. If NULL, "%a %b %d %T %Y" is assumed.
 530          * @param curtime The timestamp to convert to a human-readable string.
 531          * @param utc True to convert the time to string as-is, false to convert it to local time first.
 532          * @return A string representing the given date/time.
 533          */
 534         static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false);
 535
 536         /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function
 537          * returns false immediately (leaking information about the length), otherwise it compares each
 538          * character and only returns after all characters have been compared.
 539          * @param one First string
 540          * @param two Second string
 541          * @return True if the strings match, false if they don't
 542          */
 543         static bool TimingSafeCompare(const std::string& one, const std::string& two);
 544
 545         /** Begin execution of the server.
 546          * NOTE: this function NEVER returns. Internally,
 547          * it will repeatedly loop.
 548          */
 549         void Run();
 550
 551         char* GetReadBuffer()
 552         {
 553                 return this->ReadBuffer;
 554         }
 555 };
 556
 557 ENTRYPOINT;
 558
 559 template<class Cmd>
 560 class CommandModule : public Module
 561 {
 562         Cmd cmd;
 563  public:
 564         CommandModule() : cmd(this)
 565         {
 566         }
 567
 568         Version GetVersion() CXX11_OVERRIDE
 569         {
 570                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 571         }
 572 };
 573
 574 inline void stdalgo::culldeleter::operator()(classbase* item)
 575 {
 576         if (item)
 577                 ServerInstance->GlobalCulls.AddItem(item);
 578 }
 579
 580 #include "numericbuilder.h"
 581 #include "modules/whois.h"
 582 #include "modules/stats.h"