* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
*
* This program is free but copyrighted software; see
* the file COPYING for details.
#ifndef __INSPIRCD_H__
#define __INSPIRCD_H__
+#define _FILE_OFFSET_BITS 64
+#ifndef _LARGEFILE_SOURCE
+#define _LARGEFILE_SOURCE
+#endif
+
#ifndef WIN32
-#define DllExport
-#define CoreExport
+#define DllExport
+#define CoreExport
#define printf_c printf
#else
#include "inspircd_win32wrapper.h"
#undef ERROR
#endif
-#include <time.h>
-#include <string>
+#ifdef __GNUC__
+#define CUSTOM_PRINTF(STRING, FIRST) __attribute__((format(printf, STRING, FIRST)))
+#else
+#define CUSTOM_PRINTF(STRING, FIRST)
+#endif
+
+// Required system headers.
+#include <ctime>
+#include <cstdarg>
+#include <algorithm>
+#include <cmath>
+#include <cstring>
+#include <climits>
+#include <cstdio>
+
#include <sstream>
+#include <string>
+#include <vector>
#include <list>
+#include <deque>
+#include <map>
+#include <bitset>
+#include <set>
+
+/** A list of failed port bindings, used for informational purposes on startup */
+typedef std::vector<std::pair<std::string, std::string> > 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"
+#include "numerics.h"
#include "uid.h"
#include "users.h"
#include "channels.h"
+#include "timer.h"
+#include "hashcomp.h"
+#include "typedefs.h"
+#include "logger.h"
+#include "usermanager.h"
#include "socket.h"
+#include "ctables.h"
+#include "command_parse.h"
#include "mode.h"
#include "socketengine.h"
-#include "command_parse.h"
#include "snomasks.h"
-#include "cull_list.h"
#include "filelogger.h"
#include "caller.h"
+#include "modules.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
+#define PATH_MAX 4096
+#endif
/**
* Used to define the maximum number of parameters a command may have.
*/
#define ETIREDHAMSTERS EAGAIN
-/** Delete a pointer, and NULL its value
- */
-template<typename T> inline void DELETE(T* x)
-{
- delete x;
- x = NULL;
-}
-
/** Template function to convert any input type to std::string
*/
template<typename T> inline std::string ConvNumeric(const T &in)
* It is used by the InspIRCd class, which internally
* has an instance of it.
*/
-class serverstats : public classbase
+class serverstats
{
public:
/** Number of accepted connections
}
};
-/** A list of failed port bindings, used for informational purposes on startup */
-typedef std::vector<std::pair<std::string, long> > FailedPortList;
-
-/** A list of ip addresses cross referenced against clone counts */
-typedef std::map<irc::string, unsigned int> clonemap;
-
class InspIRCd;
-DEFINE_HANDLER1(ProcessUserHandler, void, User*);
-DEFINE_HANDLER1(IsNickHandler, bool, const char*);
+DEFINE_HANDLER2(IsNickHandler, bool, const char*, size_t);
DEFINE_HANDLER1(IsIdentHandler, bool, const char*);
-DEFINE_HANDLER1(FindDescriptorHandler, User*, int);
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&);
/* 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; }
+};
/** The main class of the irc server.
- * This class contains instances of all the other classes
- * in this software, with the exception of the base class,
- * classbase. Amongst other things, it contains a ModeParser,
- * a DNS object, a CommandParser object, and a list of active
- * Module objects, and facilities for Module objects to
- * interact with the core system it implements. You should
- * NEVER attempt to instantiate a class of type InspIRCd
- * yourself. If you do, this is equivalent to spawning a second
- * IRC server, and could have catastrophic consequences for the
- * program in terms of ram usage (basically, you could create
- * an obese forkbomb built from recursively spawning irc servers!)
+ * This class contains instances of all the other classes in this software.
+ * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
+ * object, and a list of active Module objects, and facilities for Module
+ * objects to interact with the core system it implements.
*/
-class CoreExport InspIRCd : public classbase
+class CoreExport InspIRCd
{
private:
/** Holds the current UID. Used to generate the next one.
*/
void DoSocketTimeouts(time_t TIME);
- /** Sets up UID subsystem
+ /** Increments the current UID by one.
*/
- void InitialiseUID();
+ void IncrementUID(int pos);
/** Perform background user events such as PING checks
*/
*/
time_t OLDTIME;
- /** A 64k buffer used to read client lines into
+ /** A 64k buffer used to read socket data into
+ * NOTE: update ValidateNetBufferSize if you change this
*/
char ReadBuffer[65535];
- /** Used when connecting clients
- */
- insp_sockaddr client, server;
-
- /** Used when connecting clients
- */
- socklen_t length;
-
- /** Nonblocking file writer
- */
- FileLogger* Logger;
-
- /** Time offset in seconds
- * This offset is added to all calls to Time(). Use SetTimeDelta() to update
- */
- int time_delta;
-
#ifdef WIN32
IPC* WindowsIPC;
#endif
/** Global cull list, will be processed on next iteration
*/
CullList GlobalCulls;
+ /** Actions that must happen outside of the current call stack */
+ ActionList AtomicActions;
/**** Functors ****/
- ProcessUserHandler HandleProcessUser;
IsNickHandler HandleIsNick;
IsIdentHandler HandleIsIdent;
- FindDescriptorHandler HandleFindDescriptor;
FloodQuitUserHandler HandleFloodQuitUser;
-
- /** BufferedSocket classes pending deletion after being closed.
- * We don't delete these immediately as this may cause a segmentation fault.
- */
- std::map<BufferedSocket*,BufferedSocket*> SocketCull;
+ IsChannelHandler HandleIsChannel;
+ IsSIDHandler HandleIsSID;
+ RehashHandler HandleRehash;
/** 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:
* hash and set its descriptor to FD_MAGIC_NUMBER so the data
* falls into the abyss :p
*/
- User *FakeClient;
+ FakeUser* FakeClient;
/** Returns the next available UID for this server.
*/
* @param nick The nickname 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 &);
/** Find a user in the UUID hash
* @param nick The nickname to find
* @return A pointer to the user, or NULL if the user does not exist
*/
- User *FindUUID(const char *);
+ User* FindUUID(const char *);
/** Build the ISUPPORT string by triggering all modules On005Numeric events
*/
void BuildISupport();
- /** Number of unregistered users online right now.
- * (Unregistered means before USER/NICK/dns)
- */
- int unregistered_count;
-
- /** List of server names we've seen.
- */
- servernamelist servernames;
-
/** Time this ircd was booted
*/
time_t startup_time;
/** Config file pathname specified on the commandline or via ./configure
*/
- char ConfigFileName[MAXBUF];
+ std::string ConfigFileName;
+
+ ExtensionManager Extensions;
/** Mode handler, handles mode setting and removal
*/
/** Socket engine, handles socket activity events
*/
SocketEngine* SE;
-
+
+ /** Thread engine, Handles threading where required
+ */
+ ThreadEngine* Threads;
+
+ /** The thread/class used to read config files in REHASH and on startup
+ */
+ ConfigReaderThread* ConfigThread;
+
+ /** LogManager handles logging.
+ */
+ LogManager *Logs;
+
/** ModuleManager contains everything related to loading/unloading
* modules.
*/
ModuleManager* Modules;
+ /** BanCacheManager is used to speed up checking of restrictions on connection
+ * to the IRCd.
+ */
+ BanCacheManager *BanCache;
+
/** Stats class, holds miscellaneous stats counters
*/
serverstats* stats;
*/
SnomaskManager* SNO;
- /** Client list, a hash_map containing all clients, local and remote
- */
- user_hash* clientlist;
-
- /** Client list stored by UUID. Contains all clients, and is updated
- * automatically by the constructor and destructor of User.
- */
- user_hash* uuidlist;
-
- /** Channel list, a hash_map containing all channels
- */
- chan_hash* chanlist;
-
- /** Local client list, a vector containing only local clients
- */
- std::vector<User*> local_users;
-
- /** Oper list, a vector containing all local and remote opered users
- */
- std::list<User*> all_opers;
-
- /** Map of local ip addresses for clone counting
- */
- clonemap local_clones;
-
- /** Map of global ip addresses for clone counting
- */
- clonemap global_clones;
-
/** DNS class, provides resolver facilities to the core and modules
*/
DNS* Res;
*/
XLineManager* XLines;
- /** Set to the current signal recieved
+ /** User manager. Various methods and data associated with users.
*/
- int s_signal;
+ UserManager *Users;
- /** Get the current time
- * Because this only calls time() once every time around the mainloop,
- * it is much faster than calling time() directly.
- * @param delta True to use the delta as an offset, false otherwise
- * @return The current time as an epoch value (time_t)
+ /** Channel list, a hash_map containing all channels XXX move to channel manager class
*/
- time_t Time(bool delta = false);
+ chan_hash* chanlist;
- /** Set the time offset in seconds
- * This offset is added to Time() to offset the system time by the specified
- * number of seconds.
- * @param delta The number of seconds to offset
- * @return The old time delta
+ /** List of the open ports
*/
- int SetTimeDelta(int delta);
+ std::vector<ListenSocketBase *> ports;
- /** Add a user to the local clone map
- * @param user The user to add
+ /** Set to the current signal recieved
*/
- void AddLocalClone(User* user);
+ int s_signal;
- /** Add a user to the global clone map
- * @param user The user to add
+ /** Protocol interface, overridden by server protocol modules
*/
- void AddGlobalClone(User* user);
-
- /** Number of users with a certain mode set on them
+ ProtocolInterface* PI;
+
+ /** Holds extensible for user nickforced
*/
- int ModeCount(const char mode);
+ LocalIntExt NICKForced;
- /** Get the time offset in seconds
- * @return The current time delta (in seconds)
+ /** Holds extensible for user operquit
*/
- int GetTimeDelta();
+ LocalStringExt OperQuit;
- /** Process a user whos socket has been flagged as active
- * @param cu The user to process
- * @return There is no actual return value, however upon exit, the user 'cu' may have been
- * marked for deletion in the global CullList.
+ /** 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)
*/
- caller1<void, User*> ProcessUser;
+ time_t Time();
/** Bind all ports specified in the configuration file.
- * @param bail True if the function should bail back to the shell on failure
- * @param found_ports The actual number of ports found in the config, as opposed to the number actually bound
- * @return The number of ports actually bound without error
+ * @return The number of ports bound without error
*/
- int BindPorts(bool bail, int &found_ports, FailedPortList &failed_ports);
+ int BindPorts(FailedPortList &failed_ports);
/** Binds a socket on an already open file descriptor
* @param sockfd A valid file descriptor of an open socket
* @param addr The address to bind to (IP only)
* @return True if the port was bound successfully
*/
- bool BindSocket(int sockfd, int port, char* addr, bool dolisten = true);
-
- /** Adds a server name to the list of servers we've seen
- * @param The servername to add
- */
- void AddServerName(const std::string &servername);
-
- /** Finds a cached char* pointer of a server name,
- * This is used to optimize User by storing only the pointer to the name
- * @param The servername to find
- * @return A pointer to this name, gauranteed to never become invalid
- */
- const char* FindServerNamePtr(const std::string &servername);
-
- /** Returns true if we've seen the given server name before
- * @param The servername to find
- * @return True if we've seen this server name before
- */
- bool FindServerName(const std::string &servername);
+ bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
/** Gets the GECOS (description) field of the given server.
* If the servername is not that of the local server, the name
* @param servername The servername to find the description of
* @return The description of this server, or of the local server
*/
- std::string GetServerDescription(const char* servername);
-
- /** Write text to all opers connected to this server
- * @param text The text format string
- * @param ... Format args
- */
- void WriteOpers(const char* text, ...);
-
- /** Write text to all opers connected to this server
- * @param text The text to send
- */
- void WriteOpers(const std::string &text);
+ std::string GetServerDescription(const std::string& servername);
/** Find a user in the nick hash.
* If the user cant be found in the nick hash check the uuid hash
*/
Channel* FindChan(const char* chan);
- /** Check for a 'die' tag in the config file, and abort if found
- * @return Depending on the configuration, this function may never return
- */
- void CheckDie();
-
/** Check we aren't running as root, and exit if we are
* @return Depending on the configuration, this function may never return
*/
*/
bool OpenLog(char** argv, int argc);
- /** Close the currently open log file
- */
- void CloseLog();
-
- /** Send a server notice to all local users
- * @param text The text format string to send
- * @param ... The format arguments
- */
- void ServerNoticeAll(char* text, ...);
-
- /** Send a server message (PRIVMSG) to all local users
- * @param text The text format string to send
- * @param ... The format arguments
- */
- void ServerPrivmsgAll(char* text, ...);
-
- /** Send text to all users with a specific set of modes
- * @param modes The modes to check against, without a +, e.g. 'og'
- * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
- * mode characters in the first parameter causes receipt of the message, and
- * if you specify WM_OR, all the modes must be present.
- * @param text The text format string to send
- * @param ... The format arguments
- */
- void WriteMode(const char* modes, int flags, const char* text, ...);
-
/** Return true if a channel name is valid
* @param chname A channel name to verify
* @return True if the name is valid
*/
- bool IsChannel(const char *chname);
+ caller2<bool, const char*, size_t> IsChannel;
+
+ /** Return true if str looks like a server ID
+ * @param string to check against
+ */
+ caller1<bool, const std::string&> IsSID;
/** Rehash the local server
*/
- void Rehash();
+ caller1<void, const std::string&> Rehash;
/** Handles incoming signals after being set
* @param signal the signal recieved
*/
void SignalHandler(int signal);
- /** Sets the signal recieved
+ /** Sets the signal recieved
* @param signal the signal recieved
*/
static void SetSignal(int signal);
*/
static void QuickExit(int status);
- /** Return a count of users, unknown and known connections
- * @return The number of users
- */
- int UserCount();
-
- /** Return a count of fully registered connections only
- * @return The number of registered users
- */
- int RegisteredUserCount();
-
- /** Return a count of opered (umode +o) users only
- * @return The number of opers
- */
- int OperCount();
-
- /** Return a count of unregistered (before NICK/USER) users only
- * @return The number of unregistered (unknown) connections
- */
- int UnregisteredUserCount();
-
/** Return a count of channels on the network
* @return The number of channels
*/
long ChannelCount();
- /** Return a count of local users on this server only
- * @return The number of local users
- */
- long LocalUserCount();
-
/** Send an error notice to all local users, opered and unopered
* @param s The error string to send
*/
* @param n A nickname to verify
* @return True if the nick is valid
*/
- caller1<bool, const char*> IsNick;
+ caller2<bool, const char*, size_t> IsNick;
/** Return true if an ident is valid
* @param An ident to verify
*/
caller1<bool, const char*> IsIdent;
- /** Find a username by their file descriptor.
- * It is preferred to use this over directly accessing the fd_ref_table array.
- * @param socket The file descriptor of a user
- * @return A pointer to the user if the user exists locally on this descriptor
- */
- caller1<User*, int> FindDescriptor;
-
- /** Add a new mode to this server's mode parser
- * @param mh The modehandler to add
- * @return True if the mode handler was added
- */
- bool AddMode(ModeHandler* mh);
-
- /** Add a new mode watcher to this server's mode parser
- * @param mw The modewatcher to add
- * @return True if the modewatcher was added
- */
- bool AddModeWatcher(ModeWatcher* mw);
-
- /** Delete a mode watcher from this server's mode parser
- * @param mw The modewatcher to delete
- * @return True if the modewatcher was deleted
- */
- bool DelModeWatcher(ModeWatcher* mw);
-
/** Add a dns Resolver class to this server's active set
* @param r The resolver to add
* @param cached If this value is true, then the cache will
* The parameters provided are identical to that sent to the
* handler for class cmd_mode.
* @param parameters The mode parameters
- * @param pcnt The number of items you have given in the first parameter
* @param user The user to send error messages to
*/
- void SendMode(const char **parameters, int pcnt, User *user);
+ void SendMode(const std::vector<std::string>& 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.
+ */
+ 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);
- /** Match two strings using pattern matching.
- * This operates identically to the global function match(),
- * except for that it takes std::string arguments rather than
- * const char* ones.
- * @param sliteral The literal string to match against
- * @param spattern The pattern to match against. CIDR and globs are supported.
+ /** 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.
+ * 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.
*/
- bool MatchText(const std::string &sliteral, const std::string &spattern);
+ 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);
/** Call the handler for a given command.
* @param commandname The command whos handler you wish to call
* @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 char** parameters, int pcnt, User* user);
+ CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& 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
*/
void RehashServer();
- /** Return the channel whos index number matches that provided
- * @param The index number of the channel to fetch
- * @return A channel record, or NUll if index < 0 or index >= InspIRCd::ChannelCount()
- */
- Channel* GetChannelIndex(long index);
-
/** 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, stringstream &TextStream);
+ 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
*/
long Duration(const std::string &str);
- /** Attempt to compare an oper password to a string from the config file.
+ /** Attempt to compare a password to a string from the config file.
* This will be passed to handling modules which will compare the data
* against possible hashed equivalents in the input string.
+ * @param ex The object (user, server, whatever) causing the comparison.
* @param data The data from the config file
* @param input The data input by the oper
- * @param tagnum the tag number of the oper's tag in the config file
+ * @param hashtype The hash from the config file
* @return 0 if the strings match, 1 or -1 if they do not
*/
- int OperPassCompare(const char* data,const char* input, int tagnum);
+ int PassCompare(Extensible* ex, const std::string &data, const std::string &input, const std::string &hashtype);
/** Check if a given server is a uline.
* An empty string returns true, this is by design.
* @param server The server to check for uline status
* @return True if the server is a uline OR the string is empty
*/
- bool ULine(const char* server);
+ bool ULine(const std::string& server);
/** Returns true if the uline is 'silent' (doesnt generate
* remote connect notices etc).
*/
- bool SilentULine(const char* server);
+ bool SilentULine(const std::string& server);
/** Returns the subversion revision ID of this ircd
* @return The revision ID or an empty string
*/
InspIRCd(int argc, char** argv);
- /** Output a log message to the ircd.log file
- * The text will only be output if the current loglevel
- * is less than or equal to the level you provide
- * @param level A log level from the DebugLevel enum
- * @param text Format string of to write to the log
- * @param ... Format arguments of text to write to the log
- */
- void Log(int level, const char* text, ...);
-
- /** Output a log message to the ircd.log file
- * The text will only be output if the current loglevel
- * is less than or equal to the level you provide
- * @param level A log level from the DebugLevel enum
- * @param text Text to write to the log
- */
- void Log(int level, const std::string &text);
-
/** Send a line of WHOIS data to a user.
* @param user user to send the line to
* @param dest user being WHOISed
* @param format Format string for the numeric
* @param ... Parameters for the format string
*/
- void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...);
+ void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
+
+ /** Handle /STATS
+ */
+ void DoStats(char statschar, User* user, string_list &results);
+
+ /** Handle /WHOIS
+ */
+ void DoWhois(User* user, User* dest,unsigned long signon, unsigned long idle, const char* nick);
/** Quit a user for excess flood, and if they are not
* fully registered yet, temporarily zline their IP.
*/
int Run();
- /** Force all BufferedSockets to be removed which are due to
- * be culled.
+ /** Adds an extban char to the 005 token.
*/
- void BufferedSocketCull();
+ void AddExtBanChar(char c);
char* GetReadBuffer()
{
}
};
+ENTRYPOINT;
+
+template<class Cmd>
+class CommandModule : public Module
+{
+ Cmd cmd;
+ public:
+ CommandModule() : cmd(this)
+ {
+ ServerInstance->AddCommand(&cmd);
+ }
+
+ Version GetVersion()
+ {
+ return Version(cmd.command, VF_VENDOR|VF_CORE);
+ }
+};
+
#endif
projects / user / henk / code / inspircd.git / blobdiff