Fix Doxygen syntax errors.

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

diff --git a/include/usermanager.h b/include/usermanager.h
index f994e9739a59026cf67f54d6c16cd2404637be59..92b40b373ba6b595768f40180945e6c6b04bd6c5 100644 (file)
--- a/include/usermanager.h
+++ b/include/usermanager.h
@@ -1,36 +1,70 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * 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 __USERMANAGER_H
-#define __USERMANAGER_H
+
+#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;
+typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap;
 
-class CoreExport UserManager : public classbase
+class CoreExport UserManager
 {
  private:
-       InspIRCd *ServerInstance;
-
        /** Map of local ip addresses for clone counting
         */
        clonemap local_clones;
  public:
-       UserManager(InspIRCd *Instance)
+       ~UserManager()
        {
-               ServerInstance = Instance;
+               for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++)
+               {
+                       delete i->second;
+               }
+               clientlist->clear();
+               delete clientlist;
+               delete uuidlist;
        }
 
+       /** 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<LocalUser*> 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.
         */
@@ -39,14 +73,21 @@ class CoreExport UserManager : public classbase
        /** 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
+        * @param via The socket that this user connected using
+        * @param client The IP address and client port of the user
+        * @param server The server IP address and port used by 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(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+
+       /** Disconnect a user gracefully
+        * @param user The user to remove
+        * @param quitreason The quit reason to show to normal users
+        * @param operreason 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
@@ -59,7 +100,7 @@ class CoreExport UserManager : public classbase
        void AddGlobalClone(User *user);
 
        /** Remove all clone counts from the user, you should
-        * use this if you change the user's IP address 
+        * use this if you change the user's IP address
         * after they have registered.
         * @param user The user to remove
         */
@@ -101,6 +142,25 @@ 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);
 };
 
 #endif