* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
#ifndef __USERS_H__
#define __USERS_H__
-#include <string>
-#include "inspircd_config.h"
#include "socket.h"
-#include "channels.h"
-#include "inspstring.h"
#include "connection.h"
-#include "hashcomp.h"
#include "dns.h"
+#include "mode.h"
+
/** Channel status for a user
*/
enum ChanStatus {
};
/* Required forward declaration */
-class InspIRCd;
-
-/** Derived from Resolver, and performs user forward/reverse lookups.
- */
-class CoreExport UserResolver : public Resolver
-{
- private:
- /** User this class is 'attached' to.
- */
- User* bound_user;
- /** File descriptor teh lookup is bound to
- */
- int bound_fd;
- /** True if the lookup is forward, false if is a reverse lookup
- */
- bool fwd;
- public:
- /** Create a resolver.
- * @param Instance The creating instance
- * @param user The user to begin lookup on
- * @param to_resolve The IP or host to resolve
- * @param qt The query type
- * @param cache Modified by the constructor if the result was cached
- */
- UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
-
- /** Called on successful lookup
- * @param result Result string
- * @param ttl Time to live for result
- * @param cached True if the result was found in the cache
- * @param resultnum Result number, we are only interested in result 0
- */
- void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
-
- /** Called on failed lookup
- * @param e Error code
- * @param errormessage Error message string
- */
- void OnError(ResolverError e, const std::string &errormessage);
-};
-
+class Channel;
+class UserResolver;
/** Holds information relevent to <connect allow> and <connect deny> tags in the config file.
*/
*/
std::string pass;
+ /** (Optional) Hash Method for this line
+ */
+ std::string hash;
+
/** Threshold value for flood disconnect
*/
unsigned int threshold;
*/
ConnectClass(const ConnectClass* source) : classbase(), type(source->type), name(source->name),
registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
- pingtime(source->pingtime), pass(source->pass), threshold(source->threshold), sendqmax(source->sendqmax),
+ pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
port(source->port), RefCount(0), disabled(false), limit(0)
{
/** Create a new connect class with no settings.
*/
- ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""),
+ ConnectClass() : type(CC_DENY), name("unnamed"), registration_timeout(0), flood(0), host(""), pingtime(0), pass(""), hash(""),
threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), RefCount(0), disabled(false), limit(0)
{
}
* @param hst The IP mask to allow
* @param ping The ping frequency
* @param pas The password to be used
+ * @param hsh The hash to be used
* @param thres The flooding threshold
* @param sendq The maximum sendq value
* @param recvq The maximum recvq value
* @param maxg The maximum global sessions
*/
ConnectClass(const std::string &thename, unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
- const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
+ const std::string &pas, const std::string &hsh, unsigned int thres, unsigned long sendq, unsigned long recvq,
unsigned long maxl, unsigned long maxg, unsigned int maxc, int p = 0) :
- type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas),
+ type(CC_ALLOW), name(thename), registration_timeout(timeout), flood(fld), host(hst), pingtime(ping), pass(pas), hash(hsh),
threshold(thres), sendqmax(sendq), recvqmax(recvq), maxlocal(maxl), maxglobal(maxg), maxchans(maxc), port(p), RefCount(0), disabled(false), limit(0) { }
/** Create a new connect class to DENY connections
* @param hst The IP mask to deny
*/
ConnectClass(const std::string &thename, const std::string &hst) : type(CC_DENY), name(thename), registration_timeout(0),
- flood(0), host(hst), pingtime(0), pass(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
+ flood(0), host(hst), pingtime(0), pass(""), hash(""), threshold(0), sendqmax(0), recvqmax(0), maxlocal(0), maxglobal(0), maxchans(0), port(0), RefCount(0), disabled(false), limit(0)
{
}
*/
ConnectClass(const std::string &thename, const ConnectClass* source) : type(source->type), name(thename),
registration_timeout(source->registration_timeout), flood(source->flood), host(source->host),
- pingtime(source->pingtime), pass(source->pass), threshold(source->threshold), sendqmax(source->sendqmax),
+ pingtime(source->pingtime), pass(source->pass), hash(source->hash), threshold(source->threshold), sendqmax(source->sendqmax),
recvqmax(source->recvqmax), maxlocal(source->maxlocal), maxglobal(source->maxglobal), maxchans(source->maxchans),
port(source->port), RefCount(0), disabled(false), limit(0)
{
*/
void Update(unsigned int timeout, unsigned int fld, const std::string &hst, unsigned int ping,
const std::string &pas, unsigned int thres, unsigned long sendq, unsigned long recvq,
- unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long limit)
+ unsigned long maxl, unsigned long maxg, unsigned int maxc, int p, unsigned long llimit)
{
if (timeout)
registration_timeout = timeout;
if (p)
port = p;
- this->limit = limit;
+ this->limit = llimit;
}
/** Reference counter. Contains an int as to how many users are connected to this class. :)
return pass;
}
+ /** Returns the hash or an empty string
+ */
+ const std::string& GetHash()
+ {
+ return hash;
+ }
+
/** Returns the flood threshold value
*/
unsigned int GetThreshold()
}
};
-/** Holds a complete list of all channels to which a user has been invited and has not yet joined.
+/** Holds a complete list of all channels to which a user has been invited and has not yet joined, and the time at which they'll expire.
*/
-typedef std::vector<irc::string> InvitedList;
+typedef std::vector< std::pair<irc::string, time_t> > InvitedList;
/** Holds a complete list of all allow and deny tags from the configuration file (connection classes)
*/
*/
void DecrementModes();
- /** Oper-only quit message for this user if non-null
- */
- char* operquit;
-
/** Max channels for this user
*/
unsigned int MaxChans;
+ std::map<std::string, bool>* AllowedOperCommands;
+
+ /** Allowed user modes from oper classes. */
+ bool* AllowedUserModes;
+
+ /** Allowed channel modes from oper classes. */
+ bool* AllowedChanModes;
+
public:
+ /** Module responsible for raw i/o
+ */
+ Module* io;
+
/** Contains a pointer to the connect class a user is on from - this will be NULL for remote connections.
* The pointer is guarenteed to *always* be valid. :)
*/
*/
char awaymsg[MAXAWAY+1];
+ /** Time the user last went away.
+ * This is ONLY RELIABLE if user IS_AWAY()!
+ */
+ time_t awaytime;
+
/** Timestamp of current time + connection class timeout.
* This user must send USER/NICK before this timestamp is
* reached or they will be disconnected.
*/
std::string sendq;
+ /** Message user will quit with. Not to be set externally.
+ */
+ std::string quitmsg;
+
+ /** Quit message shown to opers - not to be set externally.
+ */
+ std::string operquitmsg;
+
+ /** Whether or not to send an snotice about this user's quitting
+ */
+ bool quietquit;
+
/** Flood counters - lines received
*/
unsigned int lines_in;
*/
time_t reset_due;
- /** If this is set to true, then all read operations for the user
+ /** If this is set to true, then all socket operations for the user
* are dropped into the bit-bucket.
- * This is used by the global CullList, but please note that setting this value
- * alone will NOT cause the user to quit. This means it can be used seperately,
- * for example by shun modules etc.
+ * This value is set by QuitUser, and is not needed seperately from that call.
+ * Please note that setting this value alone will NOT cause the user to quit.
*/
- bool muted;
+ bool quitting;
/** IPV4 or IPV6 ip address. Use SetSockAddr to set this and GetProtocolFamily/
* GetIPString/GetPort to obtain its values.
*/
sockaddr* ip;
+
+ /** Set by GetIPString() to avoid constantly re-grabbing IP via sockets voodoo.
+ */
+ std::string cachedip;
/** Initialize the clients sockaddr
* @param protocol_family The protocol family of the IP address, AF_INET or AF_INET6
*/
std::string WriteError;
- /** This is true if the user matched an exception when they connected to the ircd.
- * It isnt valid after this point, and you should not attempt to do anything with it
- * after this point, because the eline might be removed at a later time, and/or no
- * longer be applicable to this user. It is only used to save doing the eline lookup
- * twice (instead we do it once and set this value).
+ /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
*/
bool exempt;
/** Adds a channel to a users invite list (invites them to a channel)
* @param channel A channel name to add
+ * @param timeout When the invite should expire (0 == never)
*/
- virtual void InviteTo(const irc::string &channel);
+ virtual void InviteTo(const irc::string &channel, time_t timeout);
/** Removes a channel from a users invite list.
* This member function is called on successfully joining an invite only channel
*/
bool HasPermission(const std::string &command);
+ /** Returns true or false if a user can set a privileged user or channel mode.
+ * This is done by looking up their oper type from User::oper, then referencing
+ * this to their oper classes, and checking the modes they can set.
+ * @param mode The mode the check
+ * @param type ModeType (MODETYPE_CHANNEL or MODETYPE_USER).
+ * @return True if the user can set or unset this mode.
+ */
+ bool HasModePermission(unsigned char mode, ModeType type);
+
/** Calls read() to read some data for this user using their fd.
* @param buffer The buffer to read into
* @param size The size of data to read
* This will also give the +o usermode.
* @param opertype The oper type to oper as
*/
- void Oper(const std::string &opertype);
+ void Oper(const std::string &opertype, const std::string &opername);
/** Call this method to find the matching <connect> for a user, and to check them against it.
*/
*/
bool ForceNickChange(const char* newnick);
- /** Add a client to the system.
- * This will create a new User, insert it into the user_hash,
- * initialize it as not yet registered, and add it to the socket engine.
- * @param Instance a pointer to the server instance
- * @param socket The socket id (file descriptor) this user is on
- * @param port The port number this user connected on
- * @param iscached This variable is reserved for future use
- * @param ip The IP address of the user
- * @return This function has no return value, but a call to AddClient may remove the user.
- */
- static void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
-
/** Oper down.
* This will clear the +o usermode and unset the user's oper type
*/
void UnOper();
- /** Return the number of global clones of this user
- * @return The global clone count of this user
- */
- unsigned long GlobalCloneCount();
-
- /** Return the number of local clones of this user
- * @return The local clone count of this user
- */
- unsigned long LocalCloneCount();
-
- /** Remove all clone counts from the user, you should
- * use this if you change the user's IP address in
- * User::ip after they have registered.
- */
- void RemoveCloneCounts();
-
/** Write text to this user, appending CR/LF.
* @param text A std::string to send to the user
*/
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void Write(const char *text, ...);
+ void Write(const char *text, ...) CUSTOM_PRINTF(2, 3);
/** Write text to this user, appending CR/LF and prepending :server.name
* @param text A std::string to send to the user
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void WriteServ(const char* text, ...);
+ void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+ void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
+
+ void WriteNumeric(unsigned int numeric, const std::string &text);
/** Write text to this user, appending CR/LF and prepending :nick!user@host of the user provided in the first parameter.
* @param user The user to prepend the :nick!user@host of
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void WriteFrom(User *user, const char* text, ...);
+ void WriteFrom(User *user, const char* text, ...) CUSTOM_PRINTF(3, 4);
/** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
* @param dest The user to route the message to
* @param text The format string for text to send to the user
* @param ... POD-type format arguments
*/
- void WriteTo(User *dest, const char *data, ...);
+ void WriteTo(User *dest, const char *data, ...) CUSTOM_PRINTF(3, 4);
/** Write to all users that can see this user (including this user in the list), appending CR/LF
* @param text A std::string to send to the users
* @param text The format string for text to send to the users
* @param ... POD-type format arguments
*/
- void WriteCommon(const char* text, ...);
+ void WriteCommon(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Write to all users that can see this user (not including this user in the list), appending CR/LF
* @param text The format string for text to send to the users
* @param ... POD-type format arguments
*/
- void WriteCommonExcept(const char* text, ...);
+ void WriteCommonExcept(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Write to all users that can see this user (not including this user in the list), appending CR/LF
* @param text A std::string to send to the users
* @param text The format string to send in the WALLOPS message
* @param ... Format arguments
*/
- void WriteWallOps(const char* text, ...);
+ void WriteWallOps(const char* text, ...) CUSTOM_PRINTF(2, 3);
/** Write a WALLOPS message from this user to all local opers.
* If this user is not opered, the function will return without doing anything.
* @param text The text format string to send
* @param ... Format arguments
*/
- void SendAll(const char* command, char* text, ...);
+ void SendAll(const char* command, const char* text, ...) CUSTOM_PRINTF(3, 4);
/** Compile a channel list for this user, and send it to the user 'source'
* Used internally by WHOIS
virtual ~User();
};
+/** Derived from Resolver, and performs user forward/reverse lookups.
+ */
+class CoreExport UserResolver : public Resolver
+{
+ private:
+ /** User this class is 'attached' to.
+ */
+ User* bound_user;
+ /** File descriptor teh lookup is bound to
+ */
+ int bound_fd;
+ /** True if the lookup is forward, false if is a reverse lookup
+ */
+ bool fwd;
+ public:
+ /** Create a resolver.
+ * @param Instance The creating instance
+ * @param user The user to begin lookup on
+ * @param to_resolve The IP or host to resolve
+ * @param qt The query type
+ * @param cache Modified by the constructor if the result was cached
+ */
+ UserResolver(InspIRCd* Instance, User* user, std::string to_resolve, QueryType qt, bool &cache);
+
+ /** Called on successful lookup
+ * @param result Result string
+ * @param ttl Time to live for result
+ * @param cached True if the result was found in the cache
+ * @param resultnum Result number, we are only interested in result 0
+ */
+ void OnLookupComplete(const std::string &result, unsigned int ttl, bool cached, int resultnum = 0);
+
+ /** Called on failed lookup
+ * @param e Error code
+ * @param errormessage Error message string
+ */
+ void OnError(ResolverError e, const std::string &errormessage);
+};
+
/* Configuration callbacks */
-class ServerConfig;
+//class ServerConfig;
#endif
projects / user / henk / code / inspircd.git / blobdiff