]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_callerid.cpp
Fix mistakenly using Clang instead of GCC on older FreeBSD versions.
[user/henk/code/inspircd.git] / src / modules / m_callerid.cpp
index 3486f1439c34b0c86eddcb26a4c55d00627986f5..4147f0b161f57a4453ea9eb3c040173d19a10576 100644 (file)
@@ -1,24 +1,30 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * 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/>.
  */
 
+
 #include "inspircd.h"
-#include <set>
-#include <sstream>
-#include <algorithm>
 
-/* $ModDesc: Implementation of callerid (umode +g & /accept, ala hybrid etc) */
+/* $ModDesc: Implementation of callerid, usermode +g, /accept */
 
-class callerid_data : public classbase
+class callerid_data
 {
  public:
        time_t lastnotify;
@@ -32,113 +38,115 @@ class callerid_data : public classbase
        std::list<callerid_data *> wholistsme;
 
        callerid_data() : lastnotify(0) { }
-       callerid_data(const std::string& str, InspIRCd* ServerInstance)
+
+       std::string ToString(SerializeFormat format) const
        {
-               irc::commasepstream s(str);
-               std::string tok;
-               if (s.GetToken(tok))
+               std::ostringstream oss;
+               oss << lastnotify;
+               for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
                {
-                       lastnotify = ConvToInt(tok);
+                       User* u = *i;
+                       // Encode UIDs.
+                       oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
                }
+               return oss.str();
+       }
+};
+
+struct CallerIDExtInfo : public ExtensionItem
+{
+       CallerIDExtInfo(Module* parent)
+               : ExtensionItem("callerid_data", parent)
+       {
+       }
+
+       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
+       {
+               callerid_data* dat = static_cast<callerid_data*>(item);
+               return dat->ToString(format);
+       }
+
+       void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
+       {
+               callerid_data* dat = new callerid_data;
+               irc::commasepstream s(value);
+               std::string tok;
+               if (s.GetToken(tok))
+                       dat->lastnotify = ConvToInt(tok);
+
                while (s.GetToken(tok))
                {
                        if (tok.empty())
-                       {
                                continue;
-                       }
 
                        User *u = ServerInstance->FindNick(tok);
-                       if (!u)
+                       if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
                        {
-                               continue;
+                               if (dat->accepting.insert(u).second)
+                               {
+                                       callerid_data* other = this->get(u, true);
+                                       other->wholistsme.push_back(dat);
+                               }
                        }
-                       accepting.insert(u);
                }
-       }
 
-       std::string ToString(bool displayable) const
-       {
-               std::ostringstream oss;
-               oss << lastnotify;
-               for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
-               {
-                       // Encode UIDs.
-                       oss << "," << (displayable ? (*i)->nick : (*i)->uuid);
-               }
-               oss << std::ends;
-               return oss.str();
+               void* old = set_raw(container, dat);
+               if (old)
+                       this->free(old);
        }
-};
 
-/** Retrieves the callerid information for a given user record
- * @param who The user to retrieve callerid information for
- * @param extend true to add callerid information if it doesn't already exist, false to return NULL if it doesn't exist
- * @return NULL if extend is false and it doesn't exist, a callerid_data instance otherwise.
- */
-callerid_data* GetData(User* who, bool extend = true)
-{
-       callerid_data* dat;
-       if (who->GetExt("callerid_data", dat))
-               return dat;
-       else
+       callerid_data* get(User* user, bool create)
        {
-               if (extend)
+               callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
+               if (create && !dat)
                {
                        dat = new callerid_data;
-                       who->Extend("callerid_data", dat);
-                       return dat;
+                       set_raw(user, dat);
                }
-               else
-                       return NULL;
+               return dat;
        }
-}
 
-void RemoveData(User* who)
-{
-       callerid_data* dat;
-       who->GetExt("callerid_data", dat);
-
-       if (!dat)
-               return;
-
-       // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
-       for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
+       void free(void* item)
        {
-               callerid_data *targ = GetData(*it, false);
-
-               if (!targ)
-                       continue; // shouldn't happen, but oh well.
+               callerid_data* dat = static_cast<callerid_data*>(item);
 
-               for (std::list<callerid_data *>::iterator it2 = targ->wholistsme.begin(); it2 != targ->wholistsme.end(); it2++)
+               // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
+               for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
                {
-                       if (*it2 == dat)
+                       callerid_data *targ = this->get(*it, false);
+
+                       if (!targ)
                        {
-                               targ->wholistsme.erase(it2);
-                               break;
+                               ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
+                               continue; // shouldn't happen, but oh well.
                        }
+
+                       std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
+                       if (it2 != targ->wholistsme.end())
+                               targ->wholistsme.erase(it2);
+                       else
+                               ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
                }
+               delete dat;
        }
-
-       who->Shrink("callerid_data");
-       delete dat;
-}
-
+};
 
 class User_g : public SimpleUserModeHandler
 {
 public:
-       User_g(InspIRCd* Instance) : SimpleUserModeHandler(Instance, 'g') { }
+       User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
 };
 
 class CommandAccept : public Command
 {
-private:
-       unsigned int& maxaccepts;
 public:
-       CommandAccept(InspIRCd* Instance, unsigned int& max) : Command(Instance, "ACCEPT", 0, 1), maxaccepts(max)
+       CallerIDExtInfo extInfo;
+       unsigned int maxaccepts;
+       CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
+               extInfo(Creator)
        {
-               source = "m_callerid.so";
-               syntax = "{[+|-]<nicks>}|*}";
+               allow_empty_last_param = false;
+               syntax = "*|(+|-)<nick>[,(+|-)<nick> ...]";
                TRANSLATE2(TR_CUSTOM, TR_END);
        }
 
@@ -146,7 +154,7 @@ public:
        {
                if (index != 0)
                        return;
-               std::string out = "";
+               std::string out;
                irc::commasepstream nicks(parameter);
                std::string tok;
                while (nicks.GetToken(tok))
@@ -163,19 +171,16 @@ public:
                                dash = true;
                                tok.erase(0, 1); // Remove the dash.
                        }
+                       else if (tok[0] == '+')
+                               tok.erase(0, 1);
+
                        User* u = ServerInstance->FindNick(tok);
-                       if (u)
-                       {
-                               if (dash)
-                                       out.append("-");
-                               out.append(u->uuid);
-                       }
-                       else
-                       {
-                               if (dash)
-                                       out.append("-");
-                               out.append(tok);
-                       }
+                       if ((!u) || (u->registered != REG_ALL) || (u->quitting) || (IS_SERVER(u)))
+                               continue;
+
+                       if (dash)
+                               out.append("-");
+                       out.append(u->uuid);
                }
                parameter = out;
        }
@@ -192,27 +197,38 @@ public:
                /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
                 * have a list already setup. */
 
-               std::string tok = parameters[0];
+               const std::string& tok = parameters[0];
 
                if (tok == "*")
                {
                        if (IS_LOCAL(user))
                                ListAccept(user);
-                       return CMD_LOCALONLY;
+                       return CMD_SUCCESS;
                }
                else if (tok[0] == '-')
                {
-                       User* whotoremove = ServerInstance->FindNick(tok.substr(1));
+                       User* whotoremove;
+                       if (IS_LOCAL(user))
+                               whotoremove = ServerInstance->FindNickOnly(tok.substr(1));
+                       else
+                               whotoremove = ServerInstance->FindNick(tok.substr(1));
+
                        if (whotoremove)
-                               return (RemoveAccept(user, whotoremove, false) ? CMD_SUCCESS : CMD_FAILURE);
+                               return (RemoveAccept(user, whotoremove) ? CMD_SUCCESS : CMD_FAILURE);
                        else
                                return CMD_FAILURE;
                }
                else
                {
-                       User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
-                       if (whotoadd)
-                               return (AddAccept(user, whotoadd, false) ? CMD_SUCCESS : CMD_FAILURE);
+                       const std::string target = (tok[0] == '+' ? tok.substr(1) : tok);
+                       User* whotoadd;
+                       if (IS_LOCAL(user))
+                               whotoadd = ServerInstance->FindNickOnly(target);
+                       else
+                               whotoadd = ServerInstance->FindNick(target);
+
+                       if ((whotoadd) && (whotoadd->registered == REG_ALL) && (!whotoadd->quitting) && (!IS_SERVER(whotoadd)))
+                               return (AddAccept(user, whotoadd) ? CMD_SUCCESS : CMD_FAILURE);
                        else
                        {
                                user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
@@ -221,9 +237,14 @@ public:
                }
        }
 
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       {
+               return ROUTE_BROADCAST;
+       }
+
        void ListAccept(User* user)
        {
-               callerid_data* dat = GetData(user, false);
+               callerid_data* dat = extInfo.get(user, false);
                if (dat)
                {
                        for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
@@ -232,72 +253,63 @@ public:
                user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
        }
 
-       bool AddAccept(User* user, User* whotoadd, bool quiet)
+       bool AddAccept(User* user, User* whotoadd)
        {
                // Add this user to my accept list first, so look me up..
-               callerid_data* dat = GetData(user, true);
+               callerid_data* dat = extInfo.get(user, true);
                if (dat->accepting.size() >= maxaccepts)
                {
-                       if (!quiet)
-                               user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
-
+                       user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
                        return false;
                }
                if (!dat->accepting.insert(whotoadd).second)
                {
-                       if (!quiet)
-                               user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
-
+                       user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
                        return false;
                }
 
                // Now, look them up, and add me to their list
-               callerid_data *targ = GetData(whotoadd, true);
+               callerid_data *targ = extInfo.get(whotoadd, true);
                targ->wholistsme.push_back(dat);
 
                user->WriteServ("NOTICE %s :%s is now on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
                return true;
        }
 
-       bool RemoveAccept(User* user, User* whotoremove, bool quiet)
+       bool RemoveAccept(User* user, User* whotoremove)
        {
                // Remove them from my list, so look up my list..
-               callerid_data* dat = GetData(user, false);
+               callerid_data* dat = extInfo.get(user, false);
                if (!dat)
                {
-                       if (!quiet)
-                               user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
-
+                       user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
                        return false;
                }
                std::set<User*>::iterator i = dat->accepting.find(whotoremove);
                if (i == dat->accepting.end())
                {
-                       if (!quiet)
-                               user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
-
+                       user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
                        return false;
                }
 
                dat->accepting.erase(i);
 
                // Look up their list to remove me.
-               callerid_data *dat2 = GetData(whotoremove, false);
+               callerid_data *dat2 = extInfo.get(whotoremove, false);
                if (!dat2)
                {
                        // How the fuck is this possible.
+                       ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
                        return false;
                }
 
-               for (std::list<callerid_data *>::iterator it = dat2->wholistsme.begin(); it != dat2->wholistsme.end(); it++)
-               {
+               std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
+               if (it != dat2->wholistsme.end())
                        // Found me!
-                       if (*it == dat)
-                       {
-                               dat2->wholistsme.erase(it);
-                               break;
-                       }
-               }
+                       dat2->wholistsme.erase(it);
+               else
+                       ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
+
 
                user->WriteServ("NOTICE %s :%s is no longer on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
                return true;
@@ -307,11 +319,10 @@ public:
 class ModuleCallerID : public Module
 {
 private:
-       CommandAccept *mycommand;
-       User_g* myumode;
+       CommandAccept cmd;
+       User_g myumode;
 
        // Configuration variables:
-       unsigned int maxaccepts; // Maximum ACCEPT entries.
        bool operoverride; // Operators can override callerid.
        bool tracknick; // Allow ACCEPT entries to update with nick changes.
        unsigned int notify_cooldown; // Seconds between notifications.
@@ -322,7 +333,7 @@ private:
        void RemoveFromAllAccepts(User* who)
        {
                // First, find the list of people who have me on accept
-               callerid_data *userdata = GetData(who, false);
+               callerid_data *userdata = cmd.extInfo.get(who, false);
                if (!userdata)
                        return;
 
@@ -336,48 +347,37 @@ private:
 
                        if (it2 != dat->accepting.end())
                                dat->accepting.erase(it2);
+                       else
+                               ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
                }
 
                userdata->wholistsme.clear();
        }
 
 public:
-       ModuleCallerID(InspIRCd* Me) : Module(Me)
+       ModuleCallerID() : cmd(this), myumode(this)
+       {
+       }
+
+       void init()
        {
                OnRehash(NULL);
-               mycommand = new CommandAccept(ServerInstance, maxaccepts);
-               myumode = new User_g(ServerInstance);
 
-               if (!ServerInstance->Modes->AddMode(myumode))
-               {
-                       delete mycommand;
-                       delete myumode;
-                       throw ModuleException("Could not add usermode +g");
-               }
-               try
-               {
-                       ServerInstance->AddCommand(mycommand);
-               }
-               catch (const ModuleException& e)
-               {
-                       delete mycommand;
-                       delete myumode;
-                       throw ModuleException("Could not add command!");
-               }
+               ServerInstance->Modules->AddService(myumode);
+               ServerInstance->Modules->AddService(cmd);
+               ServerInstance->Modules->AddService(cmd.extInfo);
 
-               Implementation eventlist[] = { I_OnRehash, I_OnUserPreNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnCleanup };
-               ServerInstance->Modules->Attach(eventlist, this, 7);
+               Implementation eventlist[] = { I_OnRehash, I_OnUserPostNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
+               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
        }
 
        virtual ~ModuleCallerID()
        {
-               ServerInstance->Modes->DelMode(myumode);
-               delete myumode;
        }
 
        virtual Version GetVersion()
        {
-               return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
+               return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
        }
 
        virtual void On005Numeric(std::string& output)
@@ -385,15 +385,15 @@ public:
                output += " CALLERID=g";
        }
 
-       int PreText(User* user, User* dest, std::string& text, bool notice)
+       ModResult PreText(User* user, User* dest, std::string& text)
        {
-               if (!dest->IsModeSet('g'))
-                       return 0;
+               if (!dest->IsModeSet('g') || (user == dest))
+                       return MOD_RES_PASSTHRU;
 
                if (operoverride && IS_OPER(user))
-                       return 0;
+                       return MOD_RES_PASSTHRU;
 
-               callerid_data* dat = GetData(dest, true);
+               callerid_data* dat = cmd.extInfo.get(dest, true);
                std::set<User*>::iterator i = dat->accepting.find(user);
 
                if (i == dat->accepting.end())
@@ -404,90 +404,49 @@ public:
                        if (now > (dat->lastnotify + (time_t)notify_cooldown))
                        {
                                user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
-                               if (IS_LOCAL(dest))
-                               {
-                                       dest->WriteNumeric(718, "%s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.", dest->nick.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), user->nick.c_str());
-                               }
-                               else
-                               {
-                                       ServerInstance->PI->PushToClient(user, std::string("::") + ServerInstance->Config->ServerName + " 718 " + dest->nick + " " + user->nick + " " + user->ident + "@" + user->dhost + " :is messaging you,  and you have umode +g. Use /ACCEPT +" + user->nick + " to allow.");
-                               }
+                               dest->SendText(":%s 718 %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
+                                       ServerInstance->Config->ServerName.c_str(), dest->nick.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), user->nick.c_str());
                                dat->lastnotify = now;
                        }
-                       return 1;
+                       return MOD_RES_DENY;
                }
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual int OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
+       virtual ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
        {
                if (IS_LOCAL(user) && target_type == TYPE_USER)
-                       return PreText(user, (User*)dest, text, true);
+                       return PreText(user, (User*)dest, text);
 
-               return 0;
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual int OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
+       virtual ModResult OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
        {
                if (IS_LOCAL(user) && target_type == TYPE_USER)
-                       return PreText(user, (User*)dest, text, true);
+                       return PreText(user, (User*)dest, text);
 
-               return 0;
-       }
-
-       virtual void OnCleanup(int type, void* item)
-       {
-               if (type != TYPE_USER)
-                       return;
-
-               User* u = (User*)item;
-               /* Cleanup only happens on unload (before dtor), so keep this O(n) instead of O(n^2) which deferring to OnUserQuit would do.  */
-               RemoveData(u);
-       }
-
-       virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string& extname, bool displayable)
-       {
-               if (extname == "callerid_data")
-               {
-                       callerid_data* dat = GetData(user, false);
-                       if (dat)
-                       {
-                               std::string str = dat->ToString(displayable);
-                               proto->ProtoSendMetaData(opaque, TYPE_USER, user, extname, str);
-                       }
-               }
-       }
-
-       virtual void OnDecodeMetaData(int target_type, void* target, const std::string& extname, const std::string& extdata)
-       {
-               if (target_type == TYPE_USER && extname == "callerid_data")
-               {
-                       User* u = (User*)target;
-                       callerid_data* dat = new callerid_data(extdata, ServerInstance);
-                       u->Extend("callerid_data", dat);
-               }
+               return MOD_RES_PASSTHRU;
        }
 
-       virtual int OnUserPreNick(User* user, const std::string& newnick)
+       void OnUserPostNick(User* user, const std::string& oldnick)
        {
                if (!tracknick)
                        RemoveFromAllAccepts(user);
-               return 0;
        }
 
-       virtual void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
+       void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
        {
                RemoveFromAllAccepts(user);
-               RemoveData(user);
        }
 
        virtual void OnRehash(User* user)
        {
-               ConfigReader Conf(ServerInstance);
-               maxaccepts = Conf.ReadInteger("callerid", "maxaccepts", "16", 0, true);
-               operoverride = Conf.ReadFlag("callerid", "operoverride", "0", 0);
-               tracknick = Conf.ReadFlag("callerid", "tracknick", "0", 0);
-               notify_cooldown = Conf.ReadInteger("callerid", "cooldown", "60", 0, true);
+               ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
+               cmd.maxaccepts = tag->getInt("maxaccepts", 16);
+               operoverride = tag->getBool("operoverride");
+               tracknick = tag->getBool("tracknick");
+               notify_cooldown = tag->getInt("cooldown", 60);
        }
 };