core_whowas Split database logic into a WhoWas::Manager class

1 files changed, 81 insertions, 32 deletions

diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h
index 798c48ee5..f9b232281 100644
--- a/include/commands/cmd_whowas.h
+++ b/include/commands/cmd_whowas.h
@@ -57,14 +57,86 @@ namespace WhoWas
 		~Nick();
 	};
 
-	/** Order in which the users were added into the map, used to remove oldest nick
-	 */
-	typedef intrusive_list_tail<Nick> FIFO;
-}
+	class Manager
+	{
+	 public:
+		/** 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);
 
-/** Sets of users in the whowas system
- */
-typedef TR1NS::unordered_map<std::string, WhoWas::Nick*, irc::insensitive, irc::StrHashComp> whowas_users;
+		/** Retrieves statistics about the whowas database
+		 * @return Whowas statistics
+		 */
+		std::string 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
@@ -73,28 +145,10 @@ typedef TR1NS::unordered_map<std::string, WhoWas::Nick*, irc::insensitive, irc::
  */
 class CommandWhowas : public Command
 {
-  private:
-	/** 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
-	 */
-	WhoWas::FIFO whowas_fifo;
-
   public:
-	/** 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.
+	/** Manager handling all whowas database related tasks
 	 */
-	unsigned int MaxKeep;
+	WhoWas::Manager manager;
 
 	CommandWhowas(Module* parent);
 	/** Handle command.
@@ -104,11 +158,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 Prune();
-	void Maintain();
-	~CommandWhowas();
 };
 
 /** Used to hold WHOWAS information