]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Add protocol api functions: PI->WriteChannelPrivmsg() and PI->WriteChannelNotice...
[user/henk/code/inspircd.git] / include / users.h
index 4d7b074b6e4c975ab2e2698d50f852abe1a37799..0fa51268d7bd191869412a461d53e1512730a0ef 100644 (file)
 #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 {
@@ -76,47 +73,8 @@ enum RegistrationState {
 };
 
 /* 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 &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file.
  */
@@ -145,6 +103,10 @@ class CoreExport ConnectClass : public classbase
         */
        std::string pass;
 
+       /** (Optional) Hash Method for this line
+        */
+       std::string hash;
+
        /** Threshold value for flood disconnect
         */
        unsigned int threshold;
@@ -179,7 +141,7 @@ public:
         */
        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)
        {
@@ -187,7 +149,7 @@ public:
 
        /** 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)
        {
        }
@@ -199,6 +161,7 @@ public:
         * @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
@@ -206,9 +169,9 @@ public:
         * @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
@@ -216,7 +179,7 @@ public:
         * @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)
        {
        }
 
@@ -226,7 +189,7 @@ public:
         */
        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)
        {
@@ -246,7 +209,7 @@ public:
         */
        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;
@@ -273,7 +236,7 @@ public:
                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. :)
@@ -356,6 +319,13 @@ public:
                return pass;
        }
 
+       /** Returns the hash or an empty string
+        */
+       const std::string& GetHash()
+       {
+               return hash;
+       }
+
        /** Returns the flood threshold value
         */
        unsigned int GetThreshold()
@@ -392,9 +362,9 @@ public:
        }
 };
 
-/** 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)
  */
@@ -487,7 +457,17 @@ class CoreExport User : public connection
 
        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. :)
         */
@@ -576,6 +556,11 @@ class CoreExport User : public connection
         */
        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.
@@ -632,18 +617,21 @@ class CoreExport User : public connection
         */
        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
@@ -765,8 +753,9 @@ class CoreExport User : public connection
 
        /** 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
@@ -783,6 +772,15 @@ class CoreExport User : public connection
         */
        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
@@ -938,7 +936,7 @@ class CoreExport User : public connection
         * @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
@@ -949,7 +947,11 @@ class CoreExport User : public connection
         * @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
@@ -962,7 +964,7 @@ class CoreExport User : public connection
         * @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
@@ -975,7 +977,7 @@ class CoreExport User : public connection
         * @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
@@ -986,13 +988,13 @@ class CoreExport User : public connection
         * @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
@@ -1011,7 +1013,7 @@ class CoreExport User : public connection
         * @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.
@@ -1061,7 +1063,7 @@ class CoreExport User : public connection
         * @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
@@ -1131,8 +1133,47 @@ class CoreExport User : public connection
        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