X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fcommands%2Fcmd_whowas.h;h=a17785c2268f7ff1582445cd2a7ea674f58fe469;hb=713fa43b98b5f4de918253f6fc735cd8542e25e3;hp=8033f1796fc4b3cf585808e6fcabcd8bc2b779dd;hpb=8c08130e19247f4a0798613ba6b931cd599115b6;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h
index 8033f1796..a17785c22 100644
--- a/include/commands/cmd_whowas.h
+++ b/include/commands/cmd_whowas.h
@@ -19,24 +19,131 @@
  */
 
 
-#ifndef CMD_WHOWAS_H
-#define CMD_WHOWAS_H
+#pragma once
+
 #include "modules.h"
 
 /* Forward ref for typedefs */
 class WhoWasGroup;
 
-/** A group of users related by nickname
- */
-typedef std::deque<WhoWasGroup*> whowas_set;
+namespace WhoWas
+{
+	/** Everything known about one nick
+	 */
+	struct Nick : public intrusive_list_node<Nick>
+	{
+		/** A group of users related by nickname
+		 */
+		typedef std::deque<WhoWasGroup*> List;
 
-/** Sets of users in the whowas system
- */
-typedef std::map<irc::string,whowas_set*> whowas_users;
+		/** Container where each element has information about one occurrence of this nick
+		 */
+		List entries;
 
-/** Sets of time and users in whowas list
- */
-typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
+		/** Time this nick was added to the database
+		 */
+		const time_t addtime;
+
+		/** Nickname whose information is stored in this class
+		 */
+		const std::string nick;
+
+		/** Constructor to initialize fields
+		 */
+		Nick(const std::string& nickname);
+
+		/** Destructor, deallocates all elements in the entries container
+		 */
+		~Nick();
+	};
+
+	class Manager
+	{
+	 public:
+		struct Stats
+		{
+			/** Number of currently existing WhoWasGroup objects
+			 */
+			size_t entrycount;
+		};
+
+		/** Add a user to the whowas database. Called when a user quits.
+		 * @param user The user to add to the database
+		 */
+		void Add(User* user);
+
+		/** Retrieves statistics about the whowas database
+		 * @return Whowas statistics as a WhoWas::Manager::Stats struct
+		 */
+		Stats GetStats() const;
+
+		/** Expires old entries
+		 */
+		void Maintain();
+
+		/** Updates the current configuration which may result in the database being pruned if the
+		 * new values are lower than the current ones.
+		 * @param NewGroupSize Maximum number of nicks allowed in the database. In case there are this many nicks
+		 * in the database and one more is added, the oldest one is removed (FIFO).
+		 * @param NewMaxGroups Maximum number of entries per nick
+		 * @param NewMaxKeep Seconds how long each nick should be kept
+		 */
+		void UpdateConfig(unsigned int NewGroupSize, unsigned int NewMaxGroups, unsigned int NewMaxKeep);
+
+		/** Retrieves all data known about a given nick
+		 * @param nick Nickname to find, case insensitive (IRC casemapping)
+		 * @return A pointer to a WhoWas::Nick if the nick was found, NULL otherwise
+		 */
+		const Nick* FindNick(const std::string& nick) const;
+
+		/** Returns true if WHOWAS is enabled according to the current configuration
+		 * @return True if WHOWAS is enabled according to the configuration, false if WHOWAS is disabled
+		 */
+		bool IsEnabled() const;
+
+		/** Constructor
+		 */
+		Manager();
+
+		/** Destructor
+		 */
+		~Manager();
+
+	 private:
+		/** Order in which the users were added into the map, used to remove oldest nick
+		 */
+		typedef intrusive_list_tail<Nick> FIFO;
+
+		/** Sets of users in the whowas system
+		 */
+		typedef TR1NS::unordered_map<std::string, WhoWas::Nick*, irc::insensitive, irc::StrHashComp> whowas_users;
+
+		/** Primary container, links nicknames tracked by WHOWAS to a list of records
+		 */
+		whowas_users whowas;
+
+		/** List of nicknames in the order they were inserted into the map
+		 */
+		FIFO whowas_fifo;
+
+		/** Max number of WhoWas entries per user.
+		 */
+		unsigned int GroupSize;
+
+		/** Max number of cumulative user-entries in WhoWas.
+		 * When max reached and added to, push out oldest entry FIFO style.
+		 */
+		unsigned int MaxGroups;
+
+		/** Max seconds a user is kept in WhoWas before being pruned.
+		 */
+		unsigned int MaxKeep;
+
+		/** Shrink all data structures to honor the current settings
+		 */
+		void Prune();
+	};
+}
 
 /** Handle /WHOWAS. These command handlers can be reloaded by the core,
  * and handle basic RFC1459 commands. Commands within modules work
@@ -45,16 +152,11 @@ typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
  */
 class CommandWhowas : public Command
 {
-  private:
-	/** Whowas container, contains a map of vectors of users tracked by WHOWAS
-	 */
-	whowas_users whowas;
-
-	/** Whowas container, contains a map of time_t to users tracked by WHOWAS
+  public:
+	/** Manager handling all whowas database related tasks
 	 */
-	whowas_users_fifo whowas_fifo;
+	WhoWas::Manager manager;
 
-  public:
 	CommandWhowas(Module* parent);
 	/** Handle command.
 	 * @param parameters The parameters to the comamnd
@@ -63,11 +165,6 @@ class CommandWhowas : public Command
 	 * @return A value from CmdResult to indicate command success or failure.
 	 */
 	CmdResult Handle(const std::vector<std::string>& parameters, User *user);
-	void AddToWhoWas(User* user);
-	std::string GetStats();
-	void PruneWhoWas(time_t t);
-	void MaintainWhoWas(time_t t);
-	~CommandWhowas();
 };
 
 /** Used to hold WHOWAS information
@@ -97,9 +194,4 @@ class WhoWasGroup
 	/** Initialize this WhoWasFroup with a user
 	 */
 	WhoWasGroup(User* user);
-	/** Destructor
-	 */
-	~WhoWasGroup();
 };
-
-#endif