]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_watch.cpp
fixed some indentation and spacing in modules
[user/henk/code/inspircd.git] / src / modules / m_watch.cpp
index 40c055979a9e5133cf5b165b4519894d2f092cfc..bbda1f593faa73cf99ba958beead0719523ae851 100644 (file)
 
 /* $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.
  *
@@ -23,7 +49,7 @@
  *
  * 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
@@ -84,20 +110,20 @@ class CommandSVSWatch : public Command
                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)
+       CmdResult Handle (const std::vector<std::string> &parameters, 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", &parameters[1], 1, u);
+                       ServerInstance->Parser->CallHandler("WATCH", parameters, u);
                }
-               
+
                return CMD_SUCCESS;
        }
 };
@@ -111,9 +137,9 @@ class CommandWatch : public Command
        CmdResult remove_watch(User* user, const char* nick)
        {
                // removing an item from the list
-               if (!ServerInstance->IsNick(nick))
+               if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
                {
-                       user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick, nick);
+                       user->WriteNumeric(942, "%s %s :Invalid nickname", user->nick.c_str(), nick);
                        return CMD_FAILURE;
                }
 
@@ -129,9 +155,9 @@ class CommandWatch : public Command
                        if (n != wl->end())
                        {
                                if (!n->second.empty())
-                                       user->WriteNumeric(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.c_str(), n->first.c_str(), n->second.c_str());
                                else
-                                       user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick, nick);
+                                       user->WriteNumeric(602, "%s %s * * 0 :stopped watching", user->nick.c_str(), nick);
 
                                wl->erase(n);
                        }
@@ -165,9 +191,9 @@ class CommandWatch : public Command
 
        CmdResult add_watch(User* user, const char* nick)
        {
-               if (!ServerInstance->IsNick(nick))
+               if (!ServerInstance->IsNick(nick, ServerInstance->Config->Limits.NickMax))
                {
-                       user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick,nick);
+                       user->WriteNumeric(942, "%s %s :Invalid nickname",user->nick.c_str(),nick);
                        return CMD_FAILURE;
                }
 
@@ -180,7 +206,7 @@ class CommandWatch : public Command
 
                if (wl->size() == MAX_WATCH)
                {
-                       user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick, nick);
+                       user->WriteNumeric(512, "%s %s :Too many WATCH entries", user->nick.c_str(), nick);
                        return CMD_FAILURE;
                }
 
@@ -207,17 +233,21 @@ class CommandWatch : public Command
                                if (target->Visibility && !target->Visibility->VisibleTo(user))
                                {
                                        (*wl)[nick] = "";
-                                       user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick, nick);
+                                       user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick);
                                        return CMD_FAILURE;
                                }
 
                                (*wl)[nick] = std::string(target->ident).append(" ").append(target->dhost).append(" ").append(ConvToStr(target->age));
-                               user->WriteNumeric(604, "%s %s %s :is online",user->nick, nick, (*wl)[nick].c_str());
+                               user->WriteNumeric(604, "%s %s %s :is online",user->nick.c_str(), nick, (*wl)[nick].c_str());
+                               if (IS_AWAY(target))
+                               {
+                                       user->WriteNumeric(609, "%s %s %s %s %lu :is away", user->nick.c_str(), target->nick.c_str(), target->ident.c_str(), target->dhost.c_str(), (unsigned long) target->awaytime);
+                               }
                        }
                        else
                        {
                                (*wl)[nick] = "";
-                               user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick, nick);
+                               user->WriteNumeric(605, "%s %s * * 0 :is offline",user->nick.c_str(), nick);
                        }
                }
 
@@ -231,9 +261,9 @@ class CommandWatch : public Command
                TRANSLATE2(TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
        }
 
-       CmdResult Handle (const char* const* parameters, int pcnt, User *user)
+       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
        {
-               if (!pcnt)
+               if (!parameters.size())
                {
                        watchlist* wl;
                        if (user->GetExt("watchlist", wl))
@@ -241,16 +271,16 @@ class CommandWatch : public Command
                                for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
                                {
                                        if (!q->second.empty())
-                                               user->WriteNumeric(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.c_str(), q->first.c_str(), q->second.c_str());
                                }
                        }
-                       user->WriteNumeric(607, "%s :End of WATCH list",user->nick);
+                       user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
                }
-               else if (pcnt > 0)
+               else if (parameters.size() > 0)
                {
-                       for (int x = 0; x < pcnt; x++)
+                       for (int x = 0; x < (int)parameters.size(); x++)
                        {
-                               const char *nick = parameters[x];
+                               const char *nick = parameters[x].c_str();
                                if (!strcasecmp(nick,"C"))
                                {
                                        // watch clear
@@ -269,7 +299,7 @@ class CommandWatch : public Command
                                                                        i2->second.erase(n);
 
                                                                if (!i2->second.size())
-                                                                       whos_watching_me->erase(user->nick);
+                                                                       whos_watching_me->erase(user->nick.c_str());
                                                        }
                                                }
 
@@ -285,12 +315,19 @@ class CommandWatch : public Command
                                                for (watchlist::iterator q = wl->begin(); q != wl->end(); q++)
                                                {
                                                        if (!q->second.empty())
-                                                               user->WriteNumeric(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.c_str(), 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.c_str(), targ->nick.c_str(), targ->ident.c_str(), targ->dhost.c_str(), (unsigned long) targ->awaytime);
+                                                               }
+                                                       }
                                                        else
-                                                               user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick, q->first.c_str());
+                                                               user->WriteNumeric(605, "%s %s * * 0 :is offline", user->nick.c_str(), q->first.c_str());
                                                }
                                        }
-                                       user->WriteNumeric(607, "%s :End of WATCH list",user->nick);
+                                       user->WriteNumeric(607, "%s :End of WATCH list",user->nick.c_str());
                                }
                                else if (!strcasecmp(nick,"S"))
                                {
@@ -306,13 +343,13 @@ class CommandWatch : public Command
                                                you_have = wl->size();
                                        }
 
-                                       watchentries::iterator i2 = whos_watching_me->find(user->nick);
+                                       watchentries::iterator i2 = whos_watching_me->find(user->nick.c_str());
                                        if (i2 != whos_watching_me->end())
                                                youre_on = i2->second.size();
 
-                                       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);
+                                       user->WriteNumeric(603, "%s :You have %d and are on %d WATCH entries", user->nick.c_str(), you_have, youre_on);
+                                       user->WriteNumeric(606, "%s :%s",user->nick.c_str(), list.c_str());
+                                       user->WriteNumeric(607, "%s :End of WATCH S",user->nick.c_str());
                                }
                                else if (nick[0] == '-')
                                {
@@ -336,7 +373,7 @@ class Modulewatch : public Module
        CommandWatch* mycommand;
        CommandSVSWatch *sw;
        unsigned int maxwatch;
-       
+
  public:
        Modulewatch(InspIRCd* Me)
                : Module(Me), maxwatch(32)
@@ -347,8 +384,8 @@ class Modulewatch : public Module
                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 &parameter)
@@ -359,21 +396,49 @@ class Modulewatch : public Module
                        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.c_str());
+               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)
        {
-               watchentries::iterator x = whos_watching_me->find(user->nick);
+               watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
                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(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.c_str() ,user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) ServerInstance->Time());
 
                                watchlist* wl;
                                if ((*n)->GetExt("watchlist", wl))
                                        /* We were on somebody's notify list, set ourselves offline */
-                                       (*wl)[user->nick] = "";
+                                       (*wl)[user->nick.c_str()] = "";
                        }
                }
 
@@ -392,9 +457,9 @@ class Modulewatch : public Module
                                                if (n != i2->second.end())
                                                        /* I'm no longer watching you... */
                                                        i2->second.erase(n);
-       
+
                                                if (!i2->second.size())
-                                                       whos_watching_me->erase(user->nick);
+                                                       whos_watching_me->erase(user->nick.c_str());
                                }
                        }
 
@@ -432,26 +497,26 @@ class Modulewatch : public Module
 
        virtual void OnPostConnect(User* user)
        {
-               watchentries::iterator x = whos_watching_me->find(user->nick);
+               watchentries::iterator x = whos_watching_me->find(user->nick.c_str());
                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(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.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) user->age);
 
                                watchlist* wl;
                                if ((*n)->GetExt("watchlist", wl))
                                        /* We were on somebody's notify list, set ourselves online */
-                                       (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
+                                       (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
                        }
                }
        }
 
        virtual void OnUserPostNick(User* user, const std::string &oldnick)
        {
-               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(oldnick.c_str());
+               watchentries::iterator new_online = whos_watching_me->find(user->nick.c_str());
 
                if (new_offline != whos_watching_me->end())
                {
@@ -461,7 +526,7 @@ class Modulewatch : public Module
                                if ((*n)->GetExt("watchlist", wl))
                                {
                                        if (!user->Visibility || user->Visibility->VisibleTo(user))
-                                               (*n)->WriteNumeric(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.c_str(), oldnick.c_str(), user->ident.c_str(), user->dhost.c_str(), (unsigned long) user->age);
                                        (*wl)[oldnick.c_str()] = "";
                                }
                        }
@@ -474,25 +539,25 @@ class Modulewatch : public Module
                                watchlist* wl;
                                if ((*n)->GetExt("watchlist", wl))
                                {
-                                       (*wl)[user->nick] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
+                                       (*wl)[user->nick.c_str()] = std::string(user->ident).append(" ").append(user->dhost).append(" ").append(ConvToStr(user->age));
                                        if (!user->Visibility || user->Visibility->VisibleTo(user))
-                                               (*n)->WriteNumeric(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.c_str(), user->nick.c_str(), (*wl)[user->nick.c_str()].c_str());
                                }
                        }
                }
-       }       
+       }
 
        virtual void On005Numeric(std::string &output)
        {
                // we don't really have a limit...
                output = output + " WATCH=" + ConvToStr(maxwatch);
        }
-       
+
        virtual ~Modulewatch()
        {
                delete whos_watching_me;
        }
-       
+
        virtual Version GetVersion()
        {
                return Version(1, 2, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);