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