* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
*/
#include "inspircd.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "hashcomp.h"
/* $ModDesc: Provides support for the /WATCH command */
+
+/*
+ * Okay, it's nice that this was documented and all, but I at least understood very little
+ * of it, so I'm going to attempt to explain the data structures in here a bit more.
+ *
+ * For efficiency, many data structures are kept.
+ *
+ * The first is a global list `watchentries':
+ * hash_map<irc::string, std::deque<User*> >
+ *
+ * That is, if nick 'w00t' is being watched by user pointer 'Brain' and 'Om', <w00t, (Brain, Om)>
+ * will be in the watchentries list.
+ *
+ * The second is that each user has a per-user data structure attached to their user record via Extensible:
+ * std::map<irc::string, std::string> watchlist;
+ * So, in the above example with w00t watched by Brain and Om, we'd have:
+ * Brain-
+ * `- w00t
+ * Om-
+ * `- w00t
+ *
+ * Hopefully this helps any brave soul that ventures into this file other than me. :-)
+ * -- w00t (mar 30, 2008)
+ */
+
+
/* This module has been refactored to provide a very efficient (in terms of cpu time)
* implementation of /WATCH.
*
* 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
+ * Each user also has a seperate (smaller) map attached to their User 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
* Yes, it's horrid. Blame cl for being different. -- w00t
*/
#ifdef WINDOWS
-typedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash_compare<irc::string, less<irc::string> > > watchentries;
+typedef nspace::hash_map<irc::string, std::deque<User*>, nspace::hash_compare<irc::string, std::less<irc::string> > > watchentries;
#else
-typedef nspace::hash_map<irc::string, std::deque<userrec*>, nspace::hash<irc::string> > watchentries;
+typedef nspace::hash_map<irc::string, std::deque<User*>, nspace::hash<irc::string> > watchentries;
#endif
typedef std::map<irc::string, std::string> watchlist;
*/
watchentries* whos_watching_me;
+class CommandSVSWatch : public Command
+{
+ public:
+ CommandSVSWatch (InspIRCd* Instance) : Command(Instance,"SVSWATCH", 0, 2)
+ {
+ this->source = "m_watch.so";
+ syntax = "<target> [C|L|S]|[+|-<nick>]";
+ TRANSLATE3(TR_NICK, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
+ }
+
+ CmdResult Handle (const char* const* parameters, int pcnt, User *user)
+ {
+ if (!ServerInstance->ULine(user->server))
+ return CMD_FAILURE;
+
+ User *u = ServerInstance->FindNick(parameters[0]);
+ if (!u)
+ return CMD_FAILURE;
+
+ if (IS_LOCAL(u))
+ {
+ ServerInstance->Parser->CallHandler("WATCH", ¶meters[1], 1, u);
+ }
+
+ return CMD_SUCCESS;
+ }
+};
+
/** Handle /WATCH
*/
-class cmd_watch : public command_t
+class CommandWatch : public Command
{
unsigned int& MAX_WATCH;
public:
- CmdResult remove_watch(userrec* user, const char* nick)
+ CmdResult remove_watch(User* user, const char* nick)
{
// removing an item from the list
if (!ServerInstance->IsNick(nick))
{
- user->WriteServ("942 %s %s :Invalid nickname", user->nick, nick);
+ user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick, nick);
return CMD_FAILURE;
}
{
/* Yup, is on my list */
watchlist::iterator n = wl->find(nick);
+
+ if (!wl)
+ return CMD_FAILURE;
+
if (n != wl->end())
{
if (!n->second.empty())
- user->WriteServ("602 %s %s %s :stopped watching", user->nick, n->first.c_str(), n->second.c_str());
+ user->WriteNumeric(602, "%s %s %s :stopped watching", user->nick, n->first.c_str(), n->second.c_str());
else
- user->WriteServ("602 %s %s * * 0 :stopped watching", user->nick, nick);
+ user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick, nick);
wl->erase(n);
}
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);
- if (n != x->second.end())
+ std::deque<User*>::iterator n2 = std::find(x->second.begin(), x->second.end(), user);
+ if (n2 != x->second.end())
/* I'm no longer watching you... */
- x->second.erase(n);
+ x->second.erase(n2);
if (!x->second.size())
whos_watching_me->erase(nick);
return CMD_FAILURE;
}
- CmdResult add_watch(userrec* user, const char* nick)
+ CmdResult add_watch(User* user, const char* nick)
{
if (!ServerInstance->IsNick(nick))
{
- user->WriteServ("942 %s %s :Invalid nickname",user->nick,nick);
+ user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick,nick);
return CMD_FAILURE;
}
if (wl->size() == MAX_WATCH)
{
- user->WriteServ("512 %s %s :Too many WATCH entries", user->nick, nick);
+ user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick, nick);
return CMD_FAILURE;
}
}
else
{
- std::deque<userrec*> newlist;
+ std::deque<User*> newlist;
newlist.push_back(user);
(*(whos_watching_me))[nick] = newlist;
}
- userrec* target = ServerInstance->FindNick(nick);
+ User* target = ServerInstance->FindNick(nick);
if (target)
{
if (target->Visibility && !target->Visibility->VisibleTo(user))
{
(*wl)[nick] = "";
- user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
+ user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick, nick);
return CMD_FAILURE;
}
(*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
- user->WriteServ("604 %s %s %s :is online",user->nick, nick, (*wl)[nick].c_str());
+ user->WriteNumeric(604, "%s %s %s :is online",user->nick, nick, (*wl)[nick].c_str());
+ if (IS_AWAY(target))
+ {
+ user->WriteNumeric(609, "%s %s %s %s %lu :is away", user->nick, target->nick, target->ident, target->dhost, (unsigned long) target->awaytime);
+ }
}
else
{
(*wl)[nick] = "";
- user->WriteServ("605 %s %s * * 0 :is offline",user->nick, nick);
+ user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick, nick);
}
}
return CMD_FAILURE;
}
- cmd_watch (InspIRCd* Instance, unsigned int &maxwatch) : command_t(Instance,"WATCH",0,0), MAX_WATCH(maxwatch)
+ CommandWatch (InspIRCd* Instance, unsigned int &maxwatch) : Command(Instance,"WATCH",0,0), MAX_WATCH(maxwatch)
{
this->source = "m_watch.so";
syntax = "[C|L|S]|[+|-<nick>]";
+ TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
}
- CmdResult Handle (const char** parameters, int pcnt, userrec *user)
+ CmdResult Handle (const char* const* parameters, int pcnt, User *user)
{
if (!pcnt)
{
for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
{
if (!q->second.empty())
- user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
+ user->WriteNumeric(604, "%s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
}
}
- user->WriteServ("607 %s :End of WATCH list",user->nick);
+ user->WriteNumeric(607, "%s :End of WATCH list",user->nick);
}
else if (pcnt > 0)
{
{
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 i2 = whos_watching_me->find(i->first);
+ if (i2 != 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);
- if (n != x->second.end())
+ std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
+ if (n != i2->second.end())
/* I'm no longer watching you... */
- x->second.erase(n);
+ i2->second.erase(n);
- if (!x->second.size())
+ if (!i2->second.size())
whos_watching_me->erase(user->nick);
}
}
for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
{
if (!q->second.empty())
- user->WriteServ("604 %s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
+ {
+ user->WriteNumeric(604, "%s %s %s :is online", user->nick, q->first.c_str(), q->second.c_str());
+ User *targ = ServerInstance->FindNick(q->first.c_str());
+ if (IS_AWAY(targ))
+ {
+ user->WriteNumeric(609, "%s %s %s %s %lu :is away", user->nick, targ->nick, targ->ident, targ->dhost, (unsigned long) targ->awaytime);
+ }
+ }
else
- user->WriteServ("605 %s %s * * 0 :is offline", user->nick, q->first.c_str());
+ user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick, q->first.c_str());
}
}
- user->WriteServ("607 %s :End of WATCH list",user->nick);
+ user->WriteNumeric(607, "%s :End of WATCH list",user->nick);
}
else if (!strcasecmp(nick,"S"))
{
you_have = wl->size();
}
- watchentries::iterator x = whos_watching_me->find(user->nick);
- if (x != whos_watching_me->end())
- youre_on = x->second.size();
+ watchentries::iterator i2 = whos_watching_me->find(user->nick);
+ if (i2 != whos_watching_me->end())
+ youre_on = i2->second.size();
- user->WriteServ("603 %s :You have %d and are on %d WATCH entries", user->nick, you_have, youre_on);
- user->WriteServ("606 %s :%s",user->nick, list.c_str());
- user->WriteServ("607 %s :End of WATCH S",user->nick);
+ user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick, you_have, youre_on);
+ user->WriteNumeric(606, "%s :%s",user->nick, list.c_str());
+ user->WriteNumeric(607, "%s :End of WATCH S",user->nick);
}
else if (nick[0] == '-')
{
class Modulewatch : public Module
{
- cmd_watch* mycommand;
+ CommandWatch* mycommand;
+ CommandSVSWatch *sw;
unsigned int maxwatch;
+
public:
-
Modulewatch(InspIRCd* Me)
: Module(Me), maxwatch(32)
{
OnRehash(NULL, "");
whos_watching_me = new watchentries();
- mycommand = new cmd_watch(ServerInstance, maxwatch);
+ mycommand = new CommandWatch(ServerInstance, maxwatch);
ServerInstance->AddCommand(mycommand);
+ sw = new CommandSVSWatch(ServerInstance);
+ ServerInstance->AddCommand(sw);
+ Implementation eventlist[] = { I_OnRehash, I_OnGarbageCollect, I_OnCleanup, I_OnUserQuit, I_OnPostConnect, I_OnUserPostNick, I_On005Numeric, I_OnSetAway };
+ ServerInstance->Modules->Attach(eventlist, this, 8);
}
- virtual void OnRehash(userrec* user, const std::string ¶meter)
+ virtual void OnRehash(User* user, const std::string ¶meter)
{
ConfigReader Conf(ServerInstance);
maxwatch = Conf.ReadInteger("watch", "maxentries", 0, true);
maxwatch = 32;
}
- void Implements(char* List)
+ virtual int OnSetAway(User *user, const std::string &awaymsg)
{
- List[I_OnRehash] = List[I_OnGarbageCollect] = List[I_OnCleanup] = List[I_OnUserQuit] = List[I_OnPostConnect] = List[I_OnUserPostNick] = List[I_On005Numeric] = 1;
+ std::string numeric;
+ int inum;
+
+ if (awaymsg.empty())
+ {
+ numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :is no longer away";
+ inum = 599;
+ }
+ else
+ {
+ numeric = std::string(user->nick) + " " + user->ident + " " + user->dhost + " " + ConvToStr(ServerInstance->Time()) + " :" + awaymsg;
+ inum = 598;
+ }
+
+ watchentries::iterator x = whos_watching_me->find(user->nick);
+ if (x != whos_watching_me->end())
+ {
+ for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
+ {
+ if (!user->Visibility || user->Visibility->VisibleTo(user))
+ (*n)->WriteNumeric(inum, numeric);
+ }
+ }
+
+ return 0;
}
- virtual void OnUserQuit(userrec* user, const std::string &reason, const std::string &oper_message)
+ virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
{
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++)
+ for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
{
if (!user->Visibility || user->Visibility->VisibleTo(user))
- (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick ,user->nick, user->ident, user->dhost, ServerInstance->Time());
+ (*n)->WriteNumeric(601, "%s %s %s %s %lu :went offline", (*n)->nick ,user->nick, user->ident, user->dhost, (unsigned long) ServerInstance->Time());
watchlist* wl;
if ((*n)->GetExt("watchlist", wl))
/* 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 i2 = whos_watching_me->find(i->first);
+ if (i2 != 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);
- if (n != x->second.end())
+ std::deque<User*>::iterator n = std::find(i2->second.begin(), i2->second.end(), user);
+ if (n != i2->second.end())
/* I'm no longer watching you... */
- x->second.erase(n);
+ i2->second.erase(n);
- if (!x->second.size())
+ if (!i2->second.size())
whos_watching_me->erase(user->nick);
}
}
/* User's quitting, we're done with this. */
delete wl;
+ user->Shrink("watchlist");
}
}
if (target_type == TYPE_USER)
{
watchlist* wl;
- userrec* user = (userrec*)item;
+ User* user = (User*)item;
if (user->GetExt("watchlist", wl))
{
}
}
- virtual void OnPostConnect(userrec* user)
+ virtual void OnPostConnect(User* user)
{
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++)
+ for (std::deque<User*>::iterator n = x->second.begin(); n != x->second.end(); n++)
{
if (!user->Visibility || user->Visibility->VisibleTo(user))
- (*n)->WriteServ("600 %s %s %s %s %lu :arrived online", (*n)->nick, user->nick, user->ident, user->dhost, user->age);
+ (*n)->WriteNumeric(600, "%s %s %s %s %lu :arrived online", (*n)->nick, user->nick, user->ident, user->dhost, (unsigned long) user->age);
watchlist* wl;
if ((*n)->GetExt("watchlist", wl))
}
}
- virtual void OnUserPostNick(userrec* user, const std::string &oldnick)
+ virtual void OnUserPostNick(User* user, const std::string &oldnick)
{
- 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);
- if (new_online != whos_watching_me->end())
+ if (new_offline != whos_watching_me->end())
{
- for (std::deque<userrec*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
+ for (std::deque<User*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
{
watchlist* wl;
if ((*n)->GetExt("watchlist", wl))
{
- (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
if (!user->Visibility || user->Visibility->VisibleTo(user))
- (*n)->WriteServ("600 %s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str());
+ (*n)->WriteNumeric(601, "%s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, (unsigned long) user->age);
+ (*wl)[oldnick.c_str()] = "";
}
}
}
- if (new_offline != whos_watching_me->end())
+ if (new_online != whos_watching_me->end())
{
- for (std::deque<userrec*>::iterator n = new_offline->second.begin(); n != new_offline->second.end(); n++)
+ for (std::deque<User*>::iterator n = new_online->second.begin(); n != new_online->second.end(); n++)
{
watchlist* wl;
if ((*n)->GetExt("watchlist", wl))
{
+ (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
if (!user->Visibility || user->Visibility->VisibleTo(user))
- (*n)->WriteServ("601 %s %s %s %s %lu :went offline", (*n)->nick, oldnick.c_str(), user->ident, user->dhost, user->age);
- (*wl)[oldnick.c_str()] = "";
+ (*n)->WriteNumeric(600, "%s %s %s :arrived online", (*n)->nick, user->nick, (*wl)[user->nick].c_str());
}
}
}
virtual Version GetVersion()
{
- return Version(1, 1, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
+ return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
}
};
projects / user / henk / code / inspircd.git / blobdiff