* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
#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 <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;
+
+/** A cached text file stored with its contents as lines
+ */
+typedef std::deque< std::string > file_cache;
+
+/** A configuration key and value pair
+ */
+typedef std::pair< std::string, std::string > KeyVal;
+
+/** A list of related configuration keys and values
+ */
+typedef std::vector< KeyVal > KeyValList;
+
+/** An entire config file, built up of KeyValLists
+ */
+typedef std::multimap< std::string, KeyValList > ConfigDataHash;
+
#include "inspircd_config.h"
+#include "numerics.h"
#include "uid.h"
#include "users.h"
-#include "usermanager.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"
+
+#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.
}
};
-/** A list of failed port bindings, used for informational purposes on startup */
-typedef std::vector<std::pair<std::string, long> > FailedPortList;
-
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
+{
+ InspIRCd* ServerInstance;
+ bool do_bail;
+ std::string TheUserUID;
+ public:
+ ConfigReaderThread(InspIRCd* Instance, bool bail, const std::string &useruid) : Thread(), ServerInstance(Instance), do_bail(bail), TheUserUID(useruid)
+ {
+ }
+
+ virtual ~ConfigReaderThread()
+ {
+ }
+
+ void Run();
+};
+
/** 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!)
+ * interact with the core system it implements.
*/
class CoreExport InspIRCd : public classbase
{
*/
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;
+ irc::sockets::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
IsIdentHandler HandleIsIdent;
FindDescriptorHandler HandleFindDescriptor;
FloodQuitUserHandler HandleFloodQuitUser;
+ IsChannelHandler HandleIsChannel;
+ IsSIDHandler HandleIsSID;
+ RehashHandler HandleRehash;
/** 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;
+ Mutex* RehashFinishMutex;
+
/** 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:
* kludge alert!
* hash and set its descriptor to FD_MAGIC_NUMBER so the data
* falls into the abyss :p
*/
- User *FakeClient;
+ User* 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;
/** Socket engine, handles socket activity events
*/
SocketEngine* SE;
-
+
+ /** Thread engine, Handles threading where required
+ */
+ ThreadEngine* Threads;
+
+ /** Mutex engine, handles mutexes for threading where required
+ */
+ MutexFactory* Mutexes;
+
+ /** 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.
*/
*/
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;
-
/** DNS class, provides resolver facilities to the core and modules
*/
DNS* Res;
*/
UserManager *Users;
+ /** Channel list, a hash_map containing all channels XXX move to channel manager class
+ */
+ chan_hash* chanlist;
+
/** Set to the current signal recieved
*/
int s_signal;
+ /** Protocol interface, overridden by server protocol modules
+ */
+ ProtocolInterface* PI;
+
/** 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)
*/
- time_t Time(bool delta = false);
-
- /** 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
- */
- int SetTimeDelta(int delta);
-
- /** Number of users with a certain mode set on them
- */
- int ModeCount(const char mode);
-
- /** Get the time offset in seconds
- * @return The current time delta (in seconds)
- */
- int GetTimeDelta();
+ time_t Time();
/** Process a user whos socket has been flagged as active
* @param cu The user to process
* @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);
+ bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
/** Adds a server name to the list of servers we've seen
* @param The servername to add
*/
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);
-
/** Find a user in the nick hash.
* If the user cant be found in the nick hash check the uuid hash
* @param nick The nickname to find
*/
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
*/
- bool IsSID(const std::string &str);
+ 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);
* @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<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.
- * 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.
+ * @param str The literal string to match against
+ * @param mask The glob pattern to match against.
*/
- bool MatchText(const std::string &sliteral, const std::string &spattern);
+ 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, 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.
+ */
+ 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
* @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);
/** 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.
*/
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);
/** Quit a user for excess flood, and if they are not
* fully registered yet, temporarily zline their IP.
*/
void BufferedSocketCull();
+ /** Adds an extban char to the 005 token.
+ */
+ void AddExtBanChar(char c);
+
char* GetReadBuffer()
{
return this->ReadBuffer;
}
};
+ENTRYPOINT;
+
#endif
projects / user / henk / code / inspircd.git / blobdiff