]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Merge pull request #1018 from SaberUK/insp20+hidekills
[user/henk/code/inspircd.git] / include / users.h
index 104b8f843b0a4deda9db6748bec7d91080e55eef..88abfbcd1c6dc8c682fa3a2597f7c2e15891f148 100644 (file)
@@ -1,23 +1,35 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2003-2007 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Burlex <???@???>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  *
- * 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 <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __USERS_H__
-#define __USERS_H__
+
+#ifndef USERS_H
+#define USERS_H
 
 #include "socket.h"
 #include "inspsocket.h"
 #include "dns.h"
 #include "mode.h"
+#include "membership.h"
 
 /** connect class types
  */
@@ -25,7 +37,9 @@ enum ClassTypes {
        /** connect:allow */
        CC_ALLOW = 0,
        /** connect:deny */
-       CC_DENY  = 1
+       CC_DENY  = 1,
+       /** named connect block (for opers, etc) */
+       CC_NAMED = 2
 };
 
 /** RFC1459 channel modes
@@ -46,7 +60,7 @@ enum UserModes {
  */
 enum RegistrationState {
 
-#ifndef WIN32   // Burlex: This is already defined in win32, luckily it is still 0.
+#ifndef _WIN32   // Burlex: This is already defined in win32, luckily it is still 0.
        REG_NONE = 0,           /* Has sent nothing */
 #endif
 
@@ -90,14 +104,6 @@ struct CoreExport ConnectClass : public refcountbase
         */
        unsigned int pingtime;
 
-       /** (Optional) Password for this line
-        */
-       std::string pass;
-
-       /** (Optional) Hash Method for this line
-        */
-       std::string hash;
-
        /** Maximum size of sendq for users in this class (bytes)
         * Users cannot send commands if they go over this limit
         */
@@ -127,13 +133,13 @@ struct CoreExport ConnectClass : public refcountbase
         */
        unsigned long maxglobal;
 
-       /** Max channels for this class
+       /** True if max connections for this class is hit and a warning is wanted
         */
-       unsigned int maxchans;
+       bool maxconnwarn;
 
-       /** Port number this connect class applies to
+       /** Max channels for this class
         */
-       int port;
+       unsigned int maxchans;
 
        /** How many users may be in this connect class before they are refused?
         * (0 = no limit = default)
@@ -150,11 +156,8 @@ struct CoreExport ConnectClass : public refcountbase
        /** Update the settings in this block to match the given block */
        void Update(const ConnectClass* newSettings);
 
-
        const std::string& GetName() { return name; }
-       const std::string& GetPass() { return pass; }
        const std::string& GetHost() { return host; }
-       const int GetPort() { return port; }
 
        /** Returns the registration timeout
         */
@@ -196,7 +199,7 @@ struct CoreExport ConnectClass : public refcountbase
         */
        unsigned int GetPenaltyThreshold()
        {
-               return (penaltythreshold ? penaltythreshold : 10);
+               return penaltythreshold ? penaltythreshold : (fakelag ? 10 : 20);
        }
 
        unsigned int GetCommandRate()
@@ -204,7 +207,7 @@ struct CoreExport ConnectClass : public refcountbase
                return commandrate ? commandrate : 1000;
        }
 
-       /** Returusn the maximum number of local sessions
+       /** Return the maximum number of local sessions
         */
        unsigned long GetMaxLocal()
        {
@@ -361,6 +364,12 @@ class CoreExport User : public Extensible
         */
        unsigned int quitting:1;
 
+       /** Recursion fix: user is out of SendQ and will be quit as soon as possible.
+        * This can't be handled normally because QuitUser itself calls Write on other
+        * users, which could trigger their SendQ to overrun.
+        */
+       unsigned int quitting_sendq:1;
+
        /** This is true if the user matched an exception (E:Line). It is used to save time on ban checks.
         */
        unsigned int exempt:1;
@@ -384,7 +393,9 @@ class CoreExport User : public Extensible
        /** Sets the client IP for this user
         * @return true if the conversion was successful
         */
-       bool SetClientIP(const char* sip);
+       virtual bool SetClientIP(const char* sip, bool recheck_eline = true);
+
+       virtual void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
 
        /** Constructor
         * @throw CoreException if the UID allocated to the user already exists
@@ -399,14 +410,14 @@ class CoreExport User : public Extensible
 
        /** Returns the full displayed host of the user
         * This member function returns the hostname of the user as seen by other users
-        * on the server, in nick!ident&at;host form.
+        * on the server, in nick!ident\@host form.
         * @return The full masked host of the user
         */
        virtual const std::string& GetFullHost();
 
        /** Returns the full real host of the user
         * This member function returns the hostname of the user as seen by other users
-        * on the server, in nick!ident&at;host form. If any form of hostname cloaking is in operation,
+        * on the server, in nick!ident\@host form. If any form of hostname cloaking is in operation,
         * e.g. through a module, then this method will ignore it and return the true hostname.
         * @return The full real host of the user
         */
@@ -443,7 +454,7 @@ class CoreExport User : public Extensible
        void SetNoticeMask(unsigned char sm, bool value);
 
        /** Create a displayable mode string for this users umodes
-        * @param The mode string
+        * @param showparameters The mode string
         */
        const char* FormatModes(bool showparameters = false);
 
@@ -487,20 +498,20 @@ class CoreExport User : public Extensible
        virtual bool HasModePermission(unsigned char mode, ModeType type);
 
        /** Creates a wildcard host.
-        * Takes a buffer to use and fills the given buffer with the host in the format *!*@hostname
-        * @return The wildcarded hostname in *!*@host form
+        * Takes a buffer to use and fills the given buffer with the host in the format *!*\@hostname
+        * @return The wildcarded hostname in *!*\@host form
         */
        char* MakeWildHost();
 
        /** Creates a usermask with real host.
-        * Takes a buffer to use and fills the given buffer with the hostmask in the format user@host
-        * @return the usermask in the format user@host
+        * Takes a buffer to use and fills the given buffer with the hostmask in the format user\@host
+        * @return the usermask in the format user\@host
         */
        const std::string& MakeHost();
 
        /** Creates a usermask with real ip.
-        * Takes a buffer to use and fills the given buffer with the ipmask in the format user@ip
-        * @return the usermask in the format user@ip
+        * Takes a buffer to use and fills the given buffer with the ipmask in the format user\@ip
+        * @return the usermask in the format user\@ip
         */
        const std::string& MakeHostIP();
 
@@ -513,14 +524,6 @@ class CoreExport User : public Extensible
         */
        void Oper(OperInfo* info);
 
-       /** Change this users hash key to a new string.
-        * You should not call this function directly. It is used by the core
-        * to update the users hash entry on a nickchange.
-        * @param New new user_hash key
-        * @return Pointer to User in hash (usually 'this')
-        */
-       User* UpdateNickHash(const char* New);
-
        /** Force a nickname change.
         * If the nickname change fails (for example, because the nick in question
         * already exists) this function will return false, and you must then either
@@ -528,7 +531,7 @@ class CoreExport User : public Extensible
         * @param newnick The nickname to change to
         * @return True if the nickchange was successful.
         */
-       bool ForceNickChange(const char* newnick);
+       inline bool ForceNickChange(const char* newnick) { return ChangeNick(newnick, true); }
 
        /** Oper down.
         * This will clear the +o usermode and unset the user's oper type
@@ -564,34 +567,35 @@ class CoreExport User : public Extensible
 
        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
+       /** 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 A std::string to send to the user
         */
        void WriteFrom(User *user, 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
+       /** 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, ...) 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.
+       /** 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 A std::string to send to the user
+        * @param data A std::string to send to the user
         */
        void WriteTo(User *dest, const std::string &data);
 
-       /** Write text to the user provided in the first parameter, appending CR/LF, and prepending THIS user's :nick!user@host.
+       /** 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 data The format string for text to send to the user
         * @param ... POD-type format arguments
         */
        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
+       /** Write to all users that can see this user (including this user in the list if include_self is true), appending CR/LF
+        * @param line A std::string to send to the users
+        * @param include_self Should the message be sent back to the author?
         */
        void WriteCommonRaw(const std::string &line, bool include_self = true);
 
@@ -638,7 +642,7 @@ class CoreExport User : public Extensible
         * Run this after the item in question has changed.
         * You should not need to use this function, call ChangeDisplayedHost instead
         *
-        * @param The entire QUIT line, including the source using the old value
+        * @param quitline The entire QUIT line, including the source using the old value
         */
        void DoHostCycle(const std::string &quitline);
 
@@ -656,7 +660,7 @@ class CoreExport User : public Extensible
         * ALWAYS use this function, rather than writing User::ident directly,
         * as this correctly causes the user to seem to quit (where configured)
         * before setting their ident field.
-        * @param host The new ident to set
+        * @param newident The new ident to set
         * @return True if the change succeeded, false if it didn't
         */
        bool ChangeIdent(const char* newident);
@@ -670,6 +674,13 @@ class CoreExport User : public Extensible
         */
        bool ChangeName(const char* gecos);
 
+       /** Change a user's nick
+        * @param newnick The new nick
+        * @param force True if the change is being forced (should not be blocked by modes like +N)
+        * @return True if the change succeeded
+        */
+       bool ChangeNick(const std::string& newnick, bool force = false);
+
        /** Send a command to all local users from this user
         * The command given must be able to send text with the
         * first parameter as a servermask (e.g. $*), so basically
@@ -704,14 +715,6 @@ class CoreExport User : public Extensible
         */
        virtual ConnectClass* GetClass();
 
-       /** Show the message of the day to this user
-        */
-       void ShowMOTD();
-
-       /** Show the server RULES file to this user
-        */
-       void ShowRULES();
-
        /** Default destructor
         */
        virtual ~User();
@@ -734,38 +737,38 @@ class CoreExport UserIOHandler : public StreamSocket
        void AddWriteBuf(const std::string &data);
 };
 
-class CoreExport LocalUser : public User
-{
-       /** A list of channels the user has a pending invite to.
-        * Upon INVITE channels are added, and upon JOIN, the
-        * channels are removed from this list.
-        */
-       InvitedList invites;
+typedef unsigned int already_sent_t;
 
+class CoreExport LocalUser : public User, public InviteBase
+{
  public:
        LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
        CullResult cull();
 
        UserIOHandler eh;
 
+       /** Position in UserManager::local_users
+        */
+       LocalUserList::iterator localuseriter;
+
        /** Stats counter for bytes inbound
         */
-       int bytes_in;
+       unsigned int bytes_in;
 
        /** Stats counter for bytes outbound
         */
-       int bytes_out;
+       unsigned int bytes_out;
 
        /** Stats counter for commands inbound
         */
-       int cmds_in;
+       unsigned int cmds_in;
 
        /** Stats counter for commands outbound
         */
-       int cmds_out;
+       unsigned int cmds_out;
 
        /** Password specified by the user when they registered (if any).
-        * This is stored even if the <connect> block doesnt need a password, so that
+        * This is stored even if the \<connect> block doesnt need a password, so that
         * modules may check it.
         */
        std::string password;
@@ -776,7 +779,7 @@ class CoreExport LocalUser : public User
 
        ConnectClass* GetClass();
 
-       /** Call this method to find the matching <connect> for a user, and to check them against it.
+       /** Call this method to find the matching \<connect> for a user, and to check them against it.
         */
        void CheckClass();
 
@@ -798,6 +801,9 @@ class CoreExport LocalUser : public User
         */
        unsigned int CommandFloodPenalty;
 
+       static already_sent_t already_sent_id;
+       already_sent_t already_sent;
+
        /** Stored reverse lookup from res_forward. Should not be used after resolution.
         */
        std::string stored_host;
@@ -814,11 +820,15 @@ class CoreExport LocalUser : public User
        void FullConnect();
 
        /** Set the connect class to which this user belongs to.
-        * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking <connect> tags from the configuration file.
+        * @param explicit_name Set this string to tie the user to a specific class name. Otherwise, the class is fitted by checking \<connect> tags from the configuration file.
         * @return A reference to this user's current connect class.
         */
        void SetClass(const std::string &explicit_name = "");
 
+       bool SetClientIP(const char* sip, bool recheck_eline = true);
+
+       void SetClientIP(const irc::sockets::sockaddrs& sa, bool recheck_eline = true);
+
        void SendText(const std::string& line);
        void Write(const std::string& text);
        void Write(const char*, ...) CUSTOM_PRINTF(2, 3);
@@ -826,7 +836,7 @@ class CoreExport LocalUser : public User
        /** Returns the list of channels this user has been invited to but has not yet joined.
         * @return A list of channels the user is invited to
         */
-       InvitedList* GetInviteList();
+       InviteList& GetInviteList();
 
        /** Returns true if a user is invited to a channel.
         * @param channel A channel name to look up
@@ -847,6 +857,8 @@ class CoreExport LocalUser : public User
         */
        void RemoveInvite(const irc::string &channel);
 
+       void RemoveExpiredInvites();
+
        /** Returns true or false for if a user can execute a privilaged oper command.
         * This is done by looking up their oper type from User::oper, then referencing
         * this to their oper classes and checking the commands they can execute.
@@ -873,8 +885,6 @@ class CoreExport LocalUser : public User
         * @return True if the user can set or unset this mode.
         */
        bool HasModePermission(unsigned char mode, ModeType type);
-
-       inline int GetFd() { return eh.GetFd(); }
 };
 
 class CoreExport RemoteUser : public User
@@ -926,18 +936,13 @@ inline FakeUser* IS_SERVER(User* u)
 class CoreExport UserResolver : public Resolver
 {
  private:
-       /** User this class is 'attached' to.
-        */
-       LocalUser* bound_user;
-       /** File descriptor teh lookup is bound to
-        */
-       int bound_fd;
+       /** UUID we are looking up */
+       std::string uuid;
        /** 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