Document SendMetaData.

[user/henk/code/inspircd.git] / include / usermanager.h

diff --git a/include/usermanager.h b/include/usermanager.h
index f994e9739a59026cf67f54d6c16cd2404637be59..6ec80c9db27ec3df018a822855ac1a57d6af7a47 100644 (file)
--- a/include/usermanager.h
+++ b/include/usermanager.h
@@ -14,10 +14,12 @@
 #ifndef __USERMANAGER_H
 #define __USERMANAGER_H
 
+#include <list>
+
 /** A list of ip addresses cross referenced against clone counts */
 typedef std::map<irc::string, unsigned int> clonemap;
 
-class CoreExport UserManager : public classbase
+class CoreExport UserManager : public Extensible
 {
  private:
        InspIRCd *ServerInstance;
@@ -26,11 +28,41 @@ class CoreExport UserManager : public classbase
         */
        clonemap local_clones;
  public:
-       UserManager(InspIRCd *Instance)
+       UserManager(InspIRCd *Instance) : ServerInstance(Instance)
+       {
+       }
+       
+       ~UserManager()
        {
-               ServerInstance = Instance;
+               for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++)
+               {
+                       delete i->second;
+               }
+               clientlist->clear();
        }
 
+       /** 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;
+
+       /** 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;
+
+       /** Number of unregistered users online right now.
+        * (Unregistered means before USER/NICK/dns)
+        */
+       int unregistered_count;
+
        /** Map of global ip addresses for clone counting
         * XXX - this should be private, but m_clones depends on it currently.
         */
@@ -46,7 +78,15 @@ class CoreExport UserManager : public classbase
         * @param ip The IP address of the user
         * @return This function has no return value, but a call to AddClient may remove the user.
         */
-       void AddClient(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip);
+       void AddUser(InspIRCd* Instance, int socket, int port, bool iscached, int socketfamily, sockaddr* ip, const std::string &targetip);
+
+       /** Disconnect a user gracefully
+        * @param user The user to remove
+        * @param r The quit reason to show to normal users
+        * @param oreason The quit reason to show to opers
+        * @return Although this function has no return type, on exit the user provided will no longer exist.
+        */
+       void QuitUser(User *user, const std::string &quitreason, const char* operreason = "");
 
        /** Add a user to the local clone map
         * @param user The user to add
@@ -101,6 +141,35 @@ class CoreExport UserManager : public classbase
         * @return The number of local users
         */
        unsigned int LocalUserCount();
+
+
+
+
+       /** Number of users with a certain mode set on them
+        */
+       int ModeCount(const char mode);
+
+       /** Send a server notice to all local users
+        * @param text The text format string to send
+        * @param ... The format arguments
+        */
+       void ServerNoticeAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+       /** Send a server message (PRIVMSG) to all local users
+        * @param text The text format string to send
+        * @param ... The format arguments
+        */
+       void ServerPrivmsgAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
+
+       /** 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, ...) CUSTOM_PRINTF(4, 5);
 };
 
 #endif