/* $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.
*
class CommandSVSWatch : public Command
{
public:
- CommandSVSWatch (InspIRCd* Instance) : Command(Instance,"WATCH", 0, 2)
+ 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** parameters, int pcnt, User *user)
+ CmdResult Handle (const char* const* parameters, int pcnt, User *user)
{
if (!ServerInstance->ULine(user->server))
return CMD_FAILURE;
// 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;
}
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 (!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;
}
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);
}
}
TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
}
- CmdResult Handle (const char** parameters, int pcnt, User *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 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"))
{
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] == '-')
{
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 };
- ServerInstance->Modules->Attach(eventlist, this, 7);
+ 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(User* user, const std::string ¶meter)
maxwatch = 32;
}
+ virtual int OnSetAway(User *user, const std::string &awaymsg)
+ {
+ 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(User* user, const std::string &reason, const std::string &oper_message)
{
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))
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))
if ((*n)->GetExt("watchlist", wl))
{
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);
+ (*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()] = "";
}
}
{
(*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(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);
}
};