* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- *<brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
-using namespace std;
-
-#include <stdio.h>
-#include <string>
-#include <vector>
#include "users.h"
#include "channels.h"
#include "modules.h"
#include "hashcomp.h"
#include "inspircd.h"
-/* $ModDesc: Provides support for the /watch command */
+/* $ModDesc: Provides support for the /WATCH command */
-/* nickname list of users watching the nick */
-typedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash<irc::string> > watchentries;
+/* This module has been refactored to provide a very efficient (in terms of cpu time)
+ * implementation of /WATCH.
+ *
+ * To improve the efficiency of watch, many lists are kept. The first primary list is
+ * a hash_map of who's being watched by who. For example:
+ *
+ * KEY: Brain ---> Watched by: Boo, w00t, Om
+ * KEY: Boo ---> Watched by: Brain, w00t
+ *
+ * This is used when we want to tell all the users that are watching someone that
+ * they are now available or no longer available. For example, if the hash was
+ * populated as shown above, then when Brain signs on, messages are sent to Boo, w00t
+ * and Om by reading their 'watched by' list. When this occurs, their online status
+ * in each of these users lists (see below) is also updated.
+ *
+ * Each user also has a seperate (smaller) map attached to their userrec whilst they
+ * have any watch entries, which is managed by class Extensible. When they add or remove
+ * a watch entry from their list, it is inserted here, as well as the main list being
+ * maintained. This map also contains the user's online status. For users that are
+ * offline, the key points at an empty string, and for users that are online, the key
+ * points at a string containing "users-ident users-host users-signon-time". This is
+ * stored in this manner so that we don't have to FindUser() to fetch this info, the
+ * users signon can populate the field for us.
+ *
+ * For example, going again on the example above, this would be w00t's watchlist:
+ *
+ * KEY: Boo ---> Status: "Boo brains.sexy.babe 535342348"
+ * KEY: Brain ---> Status: ""
+ *
+ * In this list we can see that Boo is online, and Brain is offline. We can then
+ * use this list for 'WATCH L', and 'WATCH S' can be implemented as a combination
+ * of the above two data structures, with minimum CPU penalty for doing so.
+ *
+ * In short, the least efficient this ever gets is O(n), and thats only because
+ * there are parts that *must* loop (e.g. telling all users that are watching a
+ * nick that the user online), however this is a *major* improvement over the
+ * 1.0 implementation, which in places had O(n^n) and worse in it, because this
+ * implementation scales based upon the sizes of the watch entries, whereas the
+ * old system would scale (or not as the case may be) according to the total number
+ * of users using WATCH.
+ */
-/* nickname 'ident host signon', or empty if not online */
+typedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash<irc::string> > watchentries;
typedef std::map<irc::string, std::string> watchlist;
-/* Whos watching each nickname */
-watchentries whos_watching_me;
+/* Who's watching each nickname.
+ * NOTE: We do NOT iterate this to display a user's WATCH list!
+ * See the comments above!
+ */
+watchentries* whos_watching_me;
/** Handle /WATCH
*/
delete wl;
}
- watchentries::iterator x = whos_watching_me.find(nick);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(nick);
+ if (x != whos_watching_me->end())
{
/* People are watching this user, am i one of them? */
std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
x->second.erase(n);
if (!x->second.size())
- whos_watching_me.erase(nick);
+ whos_watching_me->erase(nick);
}
}
watchlist* wl;
if (!user->GetExt("watchlist", wl))
{
- ServerInstance->Log(DEBUG,"Allocate new watchlist");
wl = new watchlist();
user->Extend("watchlist", wl);
}
watchlist::iterator n = wl->find(nick);
if (n == wl->end())
{
- ServerInstance->Log(DEBUG,"*** Add to WATCH: '%s'", nick);
/* Don't already have the user on my watch list, proceed */
- watchentries::iterator x = whos_watching_me.find(nick);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(nick);
+ if (x != whos_watching_me->end())
{
/* People are watching this user, add myself */
x->second.push_back(user);
{
std::deque<userrec*> newlist;
newlist.push_back(user);
- whos_watching_me[nick] = newlist;
+ (*(whos_watching_me))[nick] = newlist;
}
userrec* target = ServerInstance->FindNick(nick);
user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
}
}
- else
- {
- ServerInstance->Log(DEBUG,"*** WATCH entry '%s' already exists!", nick);
- }
return CMD_FAILURE;
}
for (int x = 0; x < pcnt; x++)
{
const char *nick = parameters[x];
- ServerInstance->Log(DEBUG,"WATCH iterate item '%s'", nick);
if (!strcasecmp(nick,"C"))
{
// watch clear
{
for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
{
- watchentries::iterator x = whos_watching_me.find(i->first);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(i->first);
+ if (x != whos_watching_me->end())
{
/* People are watching this user, am i one of them? */
std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
x->second.erase(n);
if (!x->second.size())
- whos_watching_me.erase(user->nick);
+ whos_watching_me->erase(user->nick);
}
}
you_have = wl->size();
}
- watchentries::iterator x = whos_watching_me.find(user->nick);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(user->nick);
+ if (x != whos_watching_me->end())
youre_on = x->second.size();
user->WriteServ("603 %s :You have %d and are on %d WATCH entries", user->nick, you_have, youre_on);
Modulewatch(InspIRCd* Me)
: Module::Module(Me), maxwatch(32)
{
+ whos_watching_me = new watchentries();
mycommand = new cmd_watch(ServerInstance, maxwatch);
ServerInstance->AddCommand(mycommand);
}
void Implements(char* List)
{
- List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1;
+ List[I_OnGarbageCollect] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1;
}
virtual void OnUserQuit(userrec* user, const std::string &reason)
{
- ServerInstance->Log(DEBUG,"*** WATCH: On global quit: user %s",user->nick);
- watchentries::iterator x = whos_watching_me.find(user->nick);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(user->nick);
+ if (x != whos_watching_me->end())
{
for (std::deque<userrec*>::iterator n = x->second.begin(); n != x->second.end(); n++)
{
/* Iterate every user on my watch list, and take me out of the whos_watching_me map for each one we're watching */
for (watchlist::iterator i = wl->begin(); i != wl->end(); i++)
{
- watchentries::iterator x = whos_watching_me.find(i->first);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(i->first);
+ if (x != whos_watching_me->end())
{
/* People are watching this user, am i one of them? */
std::deque<userrec*>::iterator n = std::find(x->second.begin(), x->second.end(), user);
x->second.erase(n);
if (!x->second.size())
- whos_watching_me.erase(user->nick);
+ whos_watching_me->erase(user->nick);
}
}
+
+ /* User's quitting, we're done with this. */
+ delete wl;
+ }
+ }
+
+ virtual void OnGarbageCollect()
+ {
+ watchentries* old_watch = whos_watching_me;
+ whos_watching_me = new watchentries();
+
+ for (watchentries::const_iterator n = old_watch->begin(); n != old_watch->end(); n++)
+ whos_watching_me->insert(*n);
+
+ delete old_watch;
+ }
+
+ virtual void OnCleanup(int target_type, void* item)
+ {
+ if (target_type == TYPE_USER)
+ {
+ watchlist* wl;
+ userrec* user = (userrec*)item;
+
+ if (user->GetExt("watchlist", wl))
+ {
+ user->Shrink("watchlist");
+ delete wl;
+ }
}
}
virtual void OnPostConnect(userrec* user)
{
- ServerInstance->Log(DEBUG,"*** WATCH: On global connect: user %s",user->nick);
- watchentries::iterator x = whos_watching_me.find(user->nick);
- if (x != whos_watching_me.end())
+ watchentries::iterator x = whos_watching_me->find(user->nick);
+ if (x != whos_watching_me->end())
{
for (std::deque<userrec*>::iterator n = x->second.begin(); n != x->second.end(); n++)
{
virtual void OnUserPostNick(userrec* user, const std::string &oldnick)
{
- ServerInstance->Log(DEBUG,"*** WATCH: On global nickchange: old nick: %s new nick: %s",oldnick.c_str(),user->nick);
-
- watchentries::iterator new_online = whos_watching_me.find(user->nick);
- watchentries::iterator new_offline = whos_watching_me.find(assign(oldnick));
+ watchentries::iterator new_online = whos_watching_me->find(user->nick);
+ watchentries::iterator new_offline = whos_watching_me->find(assign(oldnick));
- if (new_online != whos_watching_me.end())
+ if (new_online != whos_watching_me->end())
{
for (std::deque<userrec*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
{
}
}
- if (new_offline != whos_watching_me.end())
+ if (new_offline != whos_watching_me->end())
{
for (std::deque<userrec*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
{
watchlist* wl;
if ((*n)->GetExt("watchlist", wl))
{
- /*ServerInstance->Log(DEBUG,"nick=%s", (*n)->nick);
- ServerInstance->Log(DEBUG,"nick2=%s", user->nick);*/
(*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, user->age);
(*wl)[user->nick] = "";
}
virtual ~Modulewatch()
{
+ delete whos_watching_me;
}
virtual Version GetVersion()
projects / user / henk / code / inspircd.git / blobdiff