X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspircd.h;h=2f6fb01f75f702ed430e48c09fce7cc20197dfa5;hb=808a0a09577009c2d6e494979c2189426b332aef;hp=9f7d07f5d1bec200d3b0c9410291d90960302371;hpb=fa452641bf37077fcda964d59e404a76e1fb13e5;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/inspircd.h b/include/inspircd.h index 9f7d07f5d..2f6fb01f7 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -1,18 +1,30 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2008 Pippijn van Steenhoven + * Copyright (C) 2003-2008 Craig Edwards + * Copyright (C) 2006-2007 Oliver Lupton + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2003 randomdan * - * This program is free but copyrighted software; see - * the file COPYING for details. + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. * - * --------------------------------------------------- + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ -#ifndef __INSPIRCD_H__ -#define __INSPIRCD_H__ + +#ifndef INSPIRCD_H +#define INSPIRCD_H #define _FILE_OFFSET_BITS 64 #ifndef _LARGEFILE_SOURCE @@ -26,7 +38,6 @@ #else #include "inspircd_win32wrapper.h" /** Windows defines these already */ -#undef DELETE #undef ERROR #endif @@ -44,6 +55,9 @@ #include #include #include +#ifndef WIN32 +#include +#endif #include #include @@ -53,15 +67,13 @@ #include #include #include +#include +#include "inspircd_config.h" +#include "inspircd_version.h" +#include "typedefs.h" -/** A list of failed port bindings, used for informational purposes on startup */ -typedef std::vector > FailedPortList; - -class InspIRCd; CoreExport extern InspIRCd* ServerInstance; -#include "inspircd_config.h" -#include "inspircd_version.h" #include "caller.h" #include "cull_list.h" #include "extensible.h" @@ -71,7 +83,6 @@ CoreExport extern InspIRCd* ServerInstance; #include "channels.h" #include "timer.h" #include "hashcomp.h" -#include "typedefs.h" #include "logger.h" #include "usermanager.h" #include "socket.h" @@ -81,13 +92,11 @@ CoreExport extern InspIRCd* ServerInstance; #include "socketengine.h" #include "snomasks.h" #include "filelogger.h" -#include "caller.h" #include "modules.h" +#include "threadengine.h" #include "configreader.h" #include "inspstring.h" #include "protocol.h" -#include "threadengine.h" -#include "fakeuser.h" #ifndef PATH_MAX #warning Potentially broken system, PATH_MAX undefined @@ -179,29 +188,7 @@ template inline long ConvToInt(const T &in) { std::stringstream tmp; if (!(tmp << in)) return 0; - return atoi(tmp.str().c_str()); -} - -/** Template function to convert integer to char, storing result in *res and - * also returning the pointer to res. Based on Stuart Lowe's C/C++ Pages. - * @param T input value - * @param V result value - * @param R base to convert to - */ -template inline char* itoa(const T &in, V *res, R base) -{ - if (base < 2 || base > 16) { *res = 0; return res; } - char* out = res; - int quotient = in; - while (quotient) { - *out = "0123456789abcdef"[ std::abs( quotient % base ) ]; - ++out; - quotient /= base; - } - if ( in < 0 && base == 10) *out++ = '-'; - std::reverse( res, out ); - *out = 0; - return res; + return atol(tmp.str().c_str()); } /** This class contains various STATS counters @@ -241,61 +228,35 @@ class serverstats unsigned long statsConnects; /** Total bytes of data transmitted */ - double statsSent; + unsigned long statsSent; /** Total bytes of data received */ - double statsRecv; + unsigned long statsRecv; /** Cpu usage at last sample */ timeval LastCPU; /** Time last sample was read */ - timeval LastSampled; + timespec LastSampled; /** The constructor initializes all the counts to zero */ serverstats() : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0), - statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0.0), statsRecv(0.0) + statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0) { } }; -class InspIRCd; - DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t); +DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t); DEFINE_HANDLER1(IsIdentHandler, bool, const char*); DEFINE_HANDLER1(FloodQuitUserHandler, void, User*); DEFINE_HANDLER2(IsChannelHandler, bool, const char*, size_t); DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&); DEFINE_HANDLER1(RehashHandler, void, const std::string&); +DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&); -/* Forward declaration - required */ -class XLineManager; -class BanCacheManager; - -/** The background thread for config reading, so that reading from executable includes - * does not block. - */ -class CoreExport ConfigReaderThread : public Thread -{ - ServerConfig* Config; - bool done; - public: - std::string TheUserUID; - ConfigReaderThread(const std::string &useruid) - : Thread(), done(false), TheUserUID(useruid) - { - } - - virtual ~ConfigReaderThread() - { - } - - void Run(); - /** Run in the main thread to apply the configuration */ - void Finish(); - bool IsDone() { return done; } -}; +class TestSuite; /** The main class of the irc server. * This class contains instances of all the other classes in this software. @@ -336,19 +297,11 @@ class CoreExport InspIRCd * @param user The user to verify * @return True if all modules have finished checking this user */ - bool AllModulesReportReady(User* user); - - /** Logfile pathname specified on the commandline, or empty string - */ - char LogFileName[MAXBUF]; + bool AllModulesReportReady(LocalUser* user); /** The current time, updated in the mainloop */ - time_t TIME; - - /** The time that was recorded last time around the mainloop - */ - time_t OLDTIME; + struct timespec TIME; /** A 64k buffer used to read socket data into * NOTE: update ValidateNetBufferSize if you change this @@ -372,9 +325,11 @@ class CoreExport InspIRCd IsNickHandler HandleIsNick; IsIdentHandler HandleIsIdent; FloodQuitUserHandler HandleFloodQuitUser; + OnCheckExemptionHandler HandleOnCheckExemption; IsChannelHandler HandleIsChannel; IsSIDHandler HandleIsSID; RehashHandler HandleRehash; + GenRandomHandler HandleGenRandom; /** 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 * Reason for it: @@ -390,17 +345,19 @@ class CoreExport InspIRCd */ std::string GetUID(); + static const char LogHeader[]; + /** Find a user in the UUID hash - * @param nick The nickname to find + * @param uid The UUID to find * @return A pointer to the user, or NULL if the user does not exist */ - User* FindUUID(const std::string &); + User* FindUUID(const std::string &uid); /** Find a user in the UUID hash - * @param nick The nickname to find + * @param uid The UUID to find * @return A pointer to the user, or NULL if the user does not exist */ - User* FindUUID(const char *); + User* FindUUID(const char *uid); /** Build the ISUPPORT string by triggering all modules On005Numeric events */ @@ -485,7 +442,7 @@ class CoreExport InspIRCd /** List of the open ports */ - std::vector ports; + std::vector ports; /** Set to the current signal recieved */ @@ -503,12 +460,34 @@ class CoreExport InspIRCd */ LocalStringExt OperQuit; + /** Holds whether the MOTD has been parsed for color codes + */ + bool ProcessedMotdEscapes; + /** Get the current time * Because this only calls time() once every time around the mainloop, * it is much faster than calling time() directly. * @return The current time as an epoch value (time_t) */ - time_t Time(); + inline time_t Time() { return TIME.tv_sec; } + /** The fractional time at the start of this mainloop iteration (nanoseconds) */ + inline long Time_ns() { return TIME.tv_nsec; } + /** Update the current time. Don't call this unless you have reason to do so. */ + void UpdateTime(); + + /** Generate a random string with the given length + * @param length The length in bytes + * @param printable if false, the string will use characters 0-255; otherwise, + * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters) + */ + std::string GenRandomStr(int length, bool printable = true); + /** Generate a random integer. + * This is generally more secure than rand() + */ + unsigned long GenRandomInt(unsigned long max); + + /** Fill a buffer with random bits */ + caller2 GenRandom; /** Bind all ports specified in the configuration file. * @return The number of ports bound without error @@ -519,6 +498,7 @@ class CoreExport InspIRCd * @param sockfd A valid file descriptor of an open socket * @param port The port number to bind to * @param addr The address to bind to (IP only) + * @param dolisten Should this port be listened on? * @return True if the port was bound successfully */ bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true); @@ -606,7 +586,7 @@ class CoreExport InspIRCd /** Causes the server to exit after unloading modules and * closing all open file descriptors. * - * @param The exit code to give to the operating system + * @param status The exit code to give to the operating system * (See the ExitStatus enum for valid values) */ void Exit(int status); @@ -660,7 +640,10 @@ class CoreExport InspIRCd * @param f A Command command handler object to add * @throw ModuleException Will throw ModuleExcption if the command already exists */ - void AddCommand(Command *f); + inline void AddCommand(Command *f) + { + Modules->AddService(*f); + } /** Send a modechange. * The parameters provided are identical to that sent to the @@ -670,10 +653,19 @@ class CoreExport InspIRCd */ void SendMode(const std::vector& parameters, User *user); + /** Send a modechange and route it to the network. + * The parameters provided are identical to that sent to the + * handler for class cmd_mode. + * @param parameters The mode parameters + * @param user The user to send error messages to + */ + void SendGlobalMode(const std::vector& parameters, User *user); + /** Match two strings using pattern matching, optionally, with a map * to check case against (may be NULL). If map is null, match will be case insensitive. * @param str The literal string to match against * @param mask The glob pattern to match against. + * @param map The character map to use when matching. */ static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL); static bool Match(const char *str, const char *mask, unsigned const char *map = NULL); @@ -683,6 +675,7 @@ class CoreExport InspIRCd * Supports CIDR patterns as well as globs. * @param str The literal string to match against * @param mask The glob or CIDR pattern to match against. + * @param map The character map to use when matching. */ static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL); static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL); @@ -690,15 +683,14 @@ class CoreExport InspIRCd /** Call the handler for a given command. * @param commandname The command whos handler you wish to call * @param parameters The mode parameters - * @param pcnt The number of items you have given in the first parameter * @param user The user to execute the command as * @return True if the command handler was called successfully */ CmdResult CallCommandHandler(const std::string &commandname, const std::vector& parameters, User* user); /** Return true if the command is a module-implemented command and the given parameters are valid for it - * @param parameters The mode parameters - * @param pcnt The number of items you have given in the first parameter + * @param commandname The command name to check + * @param pcnt The parameter count * @param user The user to test-execute the command as * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command */ @@ -714,25 +706,6 @@ class CoreExport InspIRCd */ void RehashServer(); - /** Dump text to a user target, splitting it appropriately to fit - * @param User the user to dump the text to - * @param LinePrefix text to prefix each complete line with - * @param TextStream the text to send to the user - */ - void DumpText(User* user, const std::string &LinePrefix, std::stringstream &TextStream); - - /** Dump text to a user target (local or remote) - * @param user the user to dump the text to - * @param text the full line of text - */ - void DumpText(User* user, const std::string &text); - - /** Dump text to a user target (local or remote) - * @param user the user to dump the text to - * @param format the printf format string for the text to send - */ - void DumpText(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4); - /** Check if the given nickmask matches too many users, send errors to the given user * @param nick A nickmask to match against * @param user A user to send error text to @@ -784,15 +757,10 @@ class CoreExport InspIRCd */ bool SilentULine(const std::string& server); - /** Returns the subversion revision ID of this ircd - * @return The revision ID or an empty string - */ - std::string GetRevision(); - /** Returns the full version string of this ircd * @return The version string */ - std::string GetVersionString(); + std::string GetVersionString(bool rawversion = false); /** Attempt to write the process id to a given file * @param filename The PID file to attempt to write to @@ -840,6 +808,13 @@ class CoreExport InspIRCd */ caller1 FloodQuitUser; + /** Called to check whether a channel restriction mode applies to a user + * @param User that is attempting some action + * @param Channel that the action is being performed on + * @param Action name + */ + caller3 OnCheckExemption; + /** Restart the server. * This function will not return. If an error occurs, * it will throw an instance of CoreException. @@ -884,6 +859,8 @@ class CoreExport InspIRCd { return this->ReadBuffer; } + + friend class TestSuite; }; ENTRYPOINT; @@ -895,12 +872,16 @@ class CommandModule : public Module public: CommandModule() : cmd(this) { - ServerInstance->AddCommand(&cmd); + } + + void init() + { + ServerInstance->Modules->AddService(cmd); } Version GetVersion() { - return Version(cmd.command, VF_VENDOR|VF_CORE); + return Version(cmd.name, VF_VENDOR|VF_CORE); } };