]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/users.h
Convert LocalUserList to an intrusively linked list
[user/henk/code/inspircd.git] / include / users.h
index 0f57074b2e3fba5abb8d0882665a916376e857ad..db2d538785c9378a6367642f5adf22a680ea5c27 100644 (file)
@@ -40,19 +40,6 @@ enum ClassTypes {
        CC_NAMED = 2
 };
 
-/** RFC1459 channel modes
- */
-enum UserModes {
-       /** +s: Server notice mask */
-       UM_SNOMASK = 's' - 65,
-       /** +w: WALLOPS */
-       UM_WALLOPS = 'w' - 65,
-       /** +i: Invisible */
-       UM_INVISIBLE = 'i' - 65,
-       /** +o: Operator */
-       UM_OPERATOR = 'o' - 65
-};
-
 /** Registration state of a user, e.g.
  * have they sent USER, NICK, PASS yet?
  */
@@ -146,7 +133,7 @@ struct CoreExport ConnectClass : public refcountbase
 
        /** If set to true, no user DNS lookups are to be performed
         */
-       bool nouserdns;
+       bool resolvehostnames;
 
        /** Create a new connect class with no settings.
         */
@@ -252,6 +239,14 @@ class CoreExport User : public Extensible
         */
        std::string cachedip;
 
+       /** The user's mode list.
+        * Much love to the STL for giving us an easy to use bitset, saving us RAM.
+        * if (modes[modeletter-65]) is set, then the mode is
+        * set, for example, to work out if mode +s is set, we check the field
+        * User::modes['s'-65] != 0.
+        */
+       std::bitset<64> modes;
+
  public:
 
        /** Hostname of connection.
@@ -300,18 +295,6 @@ class CoreExport User : public Extensible
         */
        std::string fullname;
 
-       /** The user's mode list.
-        * NOT a null terminated string.
-        * Also NOT an array.
-        * Much love to the STL for giving us an easy to use bitset, saving us RAM.
-        * if (modes[modeletter-65]) is set, then the mode is
-        * set, for example, to work out if mode +s is set, we  check the field
-        * User::modes['s'-65] != 0.
-        * The following RFC characters o, w, s, i have constants defined via an
-        * enum, such as UM_SERVERNOTICE and UM_OPETATOR.
-        */
-       std::bitset<64> modes;
-
        /** What snomasks are set on this user.
         * This functions the same as the above modes.
         */
@@ -323,7 +306,7 @@ class CoreExport User : public Extensible
 
        /** The server the user is connected to.
         */
-       const std::string server;
+       Server* server;
 
        /** The user's away message.
         * If this string is empty, the user is not marked as away.
@@ -345,10 +328,6 @@ class CoreExport User : public Extensible
         */
        unsigned int registered:3;
 
-       /** Whether or not to send an snotice about this user's quitting
-        */
-       unsigned int quietquit:1;
-
        /** If this is set to true, then all socket operations for the user
         * are dropped into the bit-bucket.
         * This value is set by QuitUser, and is not needed seperately from that call.
@@ -378,7 +357,7 @@ class CoreExport User : public Extensible
        /** Constructor
         * @throw CoreException if the UID allocated to the user already exists
         */
-       User(const std::string &uid, const std::string& srv, int objtype);
+       User(const std::string& uid, Server* srv, int objtype);
 
        /** Returns the full displayed host of the user
         * This member function returns the hostname of the user as seen by other users
@@ -400,19 +379,6 @@ class CoreExport User : public Extensible
         */
        void InvalidateCache();
 
-       /** Create a displayable mode string for this users snomasks
-        * @return The notice mask character sequence
-        */
-       const char* FormatNoticeMasks();
-
-       /** Process a snomask modifier string, e.g. +abc-de
-        * @param sm A sequence of notice mask characters
-        * @return The cleaned mode sequence which can be output,
-        * e.g. in the above example if masks c and e are not
-        * valid, this function will return +ab-d
-        */
-       std::string ProcessNoticeMasks(const char *sm);
-
        /** Returns whether this user is currently away or not. If true,
         * further information can be found in User::awaymsg and User::awaytime
         * @return True if the user is away, false otherwise
@@ -431,12 +397,6 @@ class CoreExport User : public Extensible
         */
        bool IsNoticeMaskSet(unsigned char sm);
 
-       /** Changed a specific notice mask value
-        * @param sm The server notice mask to change
-        * @param value An on/off value for this mask
-        */
-       void SetNoticeMask(unsigned char sm, bool value);
-
        /** Create a displayable mode string for this users umodes
         * @param showparameters The mode string
         */
@@ -447,12 +407,16 @@ class CoreExport User : public Extensible
         * @return True if the mode is set
         */
        bool IsModeSet(unsigned char m);
+       bool IsModeSet(ModeHandler* mh);
+       bool IsModeSet(ModeHandler& mh) { return IsModeSet(&mh); }
+       bool IsModeSet(UserModeReference& moderef);
 
        /** Set a specific usermode to on or off
         * @param m The user mode
         * @param value On or off setting of the mode
         */
-       void SetMode(unsigned char m, bool value);
+       void SetMode(ModeHandler* mh, bool value);
+       void SetMode(ModeHandler& mh, bool value) { SetMode(&mh, value); }
 
        /** 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
@@ -481,12 +445,6 @@ 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
-        */
-       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
@@ -511,7 +469,7 @@ class CoreExport User : public Extensible
         * @param newnick The nickname to change to
         * @return True if the nickchange was successful.
         */
-       inline bool ForceNickChange(const char* newnick) { return ChangeNick(newnick, true); }
+       bool ForceNickChange(const std::string& newnick) { return ChangeNick(newnick, true); }
 
        /** Oper down.
         * This will clear the +o usermode and unset the user's oper type
@@ -543,6 +501,11 @@ class CoreExport User : public Extensible
         */
        void WriteServ(const char* text, ...) CUSTOM_PRINTF(2, 3);
 
+       /** Sends a server notice to this user.
+        * @param text The contents of the message to send.
+        */
+       void WriteNotice(const std::string& text);
+
        void WriteNumeric(unsigned int numeric, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
        void WriteNumeric(unsigned int numeric, const std::string &text);
@@ -599,10 +562,10 @@ class CoreExport User : public Extensible
        void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
 
        /** Dump text to a user target, splitting it appropriately to fit
-        * @param LinePrefix text to prefix each complete line with
-        * @param TextStream the text to send to the user
+        * @param linePrefix text to prefix each complete line with
+        * @param textStream the text to send to the user
         */
-       void SendText(const std::string &LinePrefix, std::stringstream &TextStream);
+       void SendText(const std::string& linePrefix, std::stringstream& textStream);
 
        /** Write to the user, routing the line if the user is remote.
         */
@@ -618,32 +581,24 @@ class CoreExport User : public Extensible
         */
        bool SharesChannelWith(User *other);
 
-       /** Send fake quit/join messages for host or ident cycle.
-        * Run this after the item in question has changed.
-        * You should not need to use this function, call ChangeDisplayedHost instead
-        *
-        * @param quitline The entire QUIT line, including the source using the old value
-        */
-       void DoHostCycle(const std::string &quitline);
-
        /** Change the displayed host of a user.
         * ALWAYS use this function, rather than writing User::dhost directly,
         * as this triggers module events allowing the change to be syncronized to
-        * remote servers. This will also emulate a QUIT and rejoin (where configured)
-        * before setting their host field.
+        * remote servers.
         * @param host The new hostname to set
         * @return True if the change succeeded, false if it didn't
+        * (a module vetoed the change).
         */
-       bool ChangeDisplayedHost(const char* host);
+       bool ChangeDisplayedHost(const std::string& host);
 
        /** Change the ident (username) of a user.
         * 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.
+        * as this triggers module events allowing the change to be syncronized to
+        * remote servers.
         * @param newident The new ident to set
         * @return True if the change succeeded, false if it didn't
         */
-       bool ChangeIdent(const char* newident);
+       bool ChangeIdent(const std::string& newident);
 
        /** Change a users realname field.
         * ALWAYS use this function, rather than writing User::fullname directly,
@@ -652,7 +607,7 @@ class CoreExport User : public Extensible
         * @param gecos The user's new realname
         * @return True if the change succeeded, false if otherwise
         */
-       bool ChangeName(const char* gecos);
+       bool ChangeName(const std::string& gecos);
 
        /** Change a user's nick
         * @param newnick The new nick
@@ -676,11 +631,6 @@ class CoreExport User : public Extensible
         */
        void PurgeEmptyChannels();
 
-       /** Get the connect class which this user belongs to. NULL for remote users.
-        * @return A pointer to this user's connect class.
-        */
-       virtual ConnectClass* GetClass();
-
        /** Default destructor
         */
        virtual ~User();
@@ -705,7 +655,7 @@ class CoreExport UserIOHandler : public StreamSocket
 
 typedef unsigned int already_sent_t;
 
-class CoreExport LocalUser : public User, public InviteBase
+class CoreExport LocalUser : public User, public InviteBase, public intrusive_list_node<LocalUser>
 {
  public:
        LocalUser(int fd, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
@@ -713,10 +663,6 @@ class CoreExport LocalUser : public User, public InviteBase
 
        UserIOHandler eh;
 
-       /** Position in UserManager::local_users
-        */
-       LocalUserList::iterator localuseriter;
-
        /** Stats counter for bytes inbound
         */
        unsigned int bytes_in;
@@ -743,11 +689,14 @@ class CoreExport LocalUser : public User, public InviteBase
         */
        reference<ConnectClass> MyClass;
 
-       ConnectClass* GetClass();
+       /** Get the connect class which this user belongs to.
+        * @return A pointer to this user's connect class.
+        */
+       ConnectClass* GetClass() const { return MyClass; }
 
        /** Call this method to find the matching \<connect> for a user, and to check them against it.
         */
-       void CheckClass();
+       void CheckClass(bool clone_count = true);
 
        /** Server address and port that this user is connected to.
         */
@@ -819,7 +768,7 @@ class CoreExport LocalUser : public User, public InviteBase
        InviteList& GetInviteList();
 
        /** Returns true if a user is invited to a channel.
-        * @param channel A channel to look up
+        * @param chan A channel to look up
         * @return True if the user is invited to the given channel
         */
        bool IsInvited(Channel* chan) { return (Invitation::Find(chan, this) != NULL); }
@@ -827,7 +776,7 @@ class CoreExport LocalUser : public User, public InviteBase
        /** Removes a channel from a users invite list.
         * This member function is called on successfully joining an invite only channel
         * to which the user has previously been invited, to clear the invitation.
-        * @param channel The channel to remove the invite to
+        * @param chan The channel to remove the invite to
         * @return True if the user was invited to the channel and the invite was erased, false if the user wasn't invited
         */
        bool RemoveInvite(Channel* chan);
@@ -865,7 +814,7 @@ class CoreExport LocalUser : public User, public InviteBase
 class CoreExport RemoteUser : public User
 {
  public:
-       RemoteUser(const std::string& uid, const std::string& srv) : User(uid, srv, USERTYPE_REMOTE)
+       RemoteUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_REMOTE)
        {
        }
        virtual void SendText(const std::string& line);
@@ -874,9 +823,15 @@ class CoreExport RemoteUser : public User
 class CoreExport FakeUser : public User
 {
  public:
-       FakeUser(const std::string &uid, const std::string& srv) : User(uid, srv, USERTYPE_SERVER)
+       FakeUser(const std::string& uid, Server* srv) : User(uid, srv, USERTYPE_SERVER)
        {
-               nick = srv;
+               nick = srv->GetName();
+       }
+
+       FakeUser(const std::string& uid, const std::string& sname, const std::string& sdesc)
+               : User(uid, new Server(sname, sdesc), USERTYPE_SERVER)
+       {
+               nick = sname;
        }
 
        virtual CullResult cull();
@@ -902,3 +857,21 @@ inline FakeUser* IS_SERVER(User* u)
        return u->usertype == USERTYPE_SERVER ? static_cast<FakeUser*>(u) : NULL;
 }
 
+inline bool User::IsModeSet(ModeHandler* mh)
+{
+       char m = mh->GetModeChar();
+       return (modes[m-65]);
+}
+
+inline bool User::IsModeSet(UserModeReference& moderef)
+{
+       if (!moderef)
+               return false;
+       return IsModeSet(*moderef);
+}
+
+inline void User::SetMode(ModeHandler* mh, bool value)
+{
+       char m = mh->GetModeChar();
+       modes[m-65] = value;
+}