-/* +------------------------------------+\r * | Inspire Internet Relay Chat Daemon |\r * +------------------------------------+\r *\r * InspIRCd is copyright (C) 2002-2007 ChatSpike-Dev.\r * E-mail:\r * <brain@chatspike.net>\r * <Craig@chatspike.net>\r *\r * Written by Craig Edwards, Craig McLure, and others.\r * This program is free but copyrighted software; see\r * the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __CMD_WHOWAS_H__\r#define __CMD_WHOWAS_H__\r\r\r// include the common header files\r\r#include "users.h"\r#include "channels.h"\r\r/* list of available internal commands */\renum Internals\r{\r WHOWAS_ADD = 1,\r WHOWAS_STATS = 2,\r WHOWAS_PRUNE = 3,\r WHOWAS_MAINTAIN = 4\r};\r\r/* Forward ref for timer */\rclass WhoWasMaintainTimer;\r\r/* Forward ref for typedefs */\rclass WhoWasGroup;\r\r/** InspTimer that is used to maintain the whowas list, called once an hour\r */\rextern WhoWasMaintainTimer* timer;\r\r/** A group of users related by nickname\r */\rtypedef std::deque<WhoWasGroup*> whowas_set;\r\r/** Sets of users in the whowas system\r */\rtypedef std::map<irc::string,whowas_set*> whowas_users;\r\r/** Sets of time and users in whowas list\r */\rtypedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;\r\r/** Handle /WHOWAS. These command handlers can be reloaded by the core,\r * and handle basic RFC1459 commands. Commands within modules work\r * the same way, however, they can be fully unloaded, where these\r * may not.\r */\rclass cmd_whowas : public command_t\r{\r private:\r /** Whowas container, contains a map of vectors of users tracked by WHOWAS\r */\r whowas_users whowas;\r \r /** Whowas container, contains a map of time_t to users tracked by WHOWAS\r */\r whowas_users_fifo whowas_fifo;\r\r /* String holding stats so it can be collected\r */\r std::string stats;\r\r public:\r cmd_whowas(InspIRCd* Instance);\r /** Handle command.\r * @param parameters The parameters to the comamnd\r * @param pcnt The number of parameters passed to teh command\r * @param user The user issuing the command\r * @return A value from CmdResult to indicate command success or failure.\r */\r CmdResult Handle(const char** parameters, int pcnt, userrec *user);\r /** Handle command.\r * @param parameters The parameters to the comamnd\r * @param pcnt The number of parameters passed to teh command\r * @param user The user issuing the command\r * @return A value from CmdResult to indicate command success or failure.\r */\r CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> ¶meters);\r void AddToWhoWas(userrec* user);\r void GetStats(Extensible* ext);\r void PruneWhoWas(time_t t);\r void MaintainWhoWas(time_t t);\r virtual ~cmd_whowas();\r};\r\r/** Used to hold WHOWAS information\r */\rclass WhoWasGroup : public classbase\r{\r public:\r /** Real host\r */\r char* host;\r /** Displayed host\r */\r char* dhost;\r /** Ident\r */\r char* ident;\r /** Server name\r */\r const char* server;\r /** Fullname (GECOS)\r */\r char* gecos;\r /** Signon time\r */\r time_t signon;\r\r /** Initialize this WhoQasFroup with a user\r */\r WhoWasGroup(userrec* user);\r /** Destructor\r */\r ~WhoWasGroup();\r};\r\rclass WhoWasMaintainTimer : public InspTimer\r{\r private:\r InspIRCd* ServerInstance;\r public:\r WhoWasMaintainTimer(InspIRCd* Instance, long interval)\r : InspTimer(interval, Instance->Time(), true), ServerInstance(Instance)\r {\r }\r virtual void Tick(time_t TIME);\r};\r\r#endif\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
+ *
+ * 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/>.
+ */
+
+
+#pragma once
+
+#include "modules.h"
+
+namespace WhoWas
+{
+ /** One entry for a nick. There may be multiple entries for a nick.
+ */
+ struct Entry
+ {
+ /** Real host
+ */
+ const std::string host;
+
+ /** Displayed host
+ */
+ const std::string dhost;
+
+ /** Ident
+ */
+ const std::string ident;
+
+ /** Server name
+ */
+ const std::string server;
+
+ /** Full name (GECOS)
+ */
+ const std::string gecos;
+
+ /** Signon time
+ */
+ const time_t signon;
+
+ /** Initialize this Entry with a user
+ */
+ Entry(User* user);
+ };
+
+ /** Everything known about one nick
+ */
+ struct Nick : public insp::intrusive_list_node<Nick>
+ {
+ /** A group of users related by nickname
+ */
+ typedef std::deque<Entry*> List;
+
+ /** Container where each element has information about one occurrence of this nick
+ */
+ List entries;
+
+ /** 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 WhoWas::Entry 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 insp::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();
+
+ /** Remove a nick (and all entries belonging to it) from the database
+ * @param it Iterator to the nick to purge
+ */
+ void PurgeNick(whowas_users::iterator it);
+
+ /** Remove a nick (and all entries belonging to it) from the database
+ * @param nick Nick to purge
+ */
+ void PurgeNick(WhoWas::Nick* nick);
+ };
+}
+
+/** Handle /WHOWAS. These command handlers can be reloaded by the core,
+ * and handle basic RFC1459 commands. Commands within modules work
+ * the same way, however, they can be fully unloaded, where these
+ * may not.
+ */
+class CommandWhowas : public Command
+{
+ public:
+ /** Manager handling all whowas database related tasks
+ */
+ WhoWas::Manager manager;
+
+ CommandWhowas(Module* parent);
+ /** Handle command.
+ * @param parameters The parameters to the comamnd
+ * @param user The user issuing the command
+ * @return A value from CmdResult to indicate command success or failure.
+ */
+ CmdResult Handle(const std::vector<std::string>& parameters, User *user);
+};
projects / user / henk / code / inspircd.git / blobdiff