]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_callerid.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_callerid.cpp
index 26b9d0da250bee2e185005c73b6dab0717bf5e57..361e2bdda21e8f4353fc5813a2edb665b7ca42f8 100644 (file)
@@ -1,10 +1,16 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
- *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2013, 2017-2019, 2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2013 Adam <Adam@anope.org>
+ *   Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2009 John Brooks <special@inspircd.org>
  *   Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
- *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
  *
  * 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
@@ -21,6 +27,8 @@
 
 
 #include "inspircd.h"
+#include "modules/callerid.h"
+#include "modules/ctctags.h"
 
 enum
 {
@@ -37,7 +45,7 @@ enum
 class callerid_data
 {
  public:
-       typedef insp::flat_set<User*> UserSet;
+       typedef insp::flat_set<User*> UserSet;
        typedef std::vector<callerid_data*> CallerIdDataSet;
 
        time_t lastnotify;
@@ -52,15 +60,17 @@ class callerid_data
 
        callerid_data() : lastnotify(0) { }
 
-       std::string ToString(SerializeFormat format) const
+       std::string ToString(bool human) const
        {
                std::ostringstream oss;
                oss << lastnotify;
                for (UserSet::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
                {
                        User* u = *i;
-                       // Encode UIDs.
-                       oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
+                       if (human)
+                               oss << ' ' << u->nick;
+                       else
+                               oss << ',' << u->uuid;
                }
                return oss.str();
        }
@@ -73,32 +83,35 @@ struct CallerIDExtInfo : public ExtensionItem
        {
        }
 
-       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
+       std::string ToHuman(const Extensible* container, void* item) const CXX11_OVERRIDE
        {
-               std::string ret;
-               if (format != FORMAT_NETWORK)
-               {
-                       callerid_data* dat = static_cast<callerid_data*>(item);
-                       ret = dat->ToString(format);
-               }
-               return ret;
+               callerid_data* dat = static_cast<callerid_data*>(item);
+               return dat->ToString(true);
        }
 
-       void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
+       std::string ToInternal(const Extensible* container, void* item) const CXX11_OVERRIDE
        {
-               if (format == FORMAT_NETWORK)
-                       return;
+               callerid_data* dat = static_cast<callerid_data*>(item);
+               return dat->ToString(false);
+       }
 
+       void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE
+       {
+               void* old = get_raw(container);
+               if (old)
+                       this->free(NULL, old);
                callerid_data* dat = new callerid_data;
+               set_raw(container, dat);
+
                irc::commasepstream s(value);
                std::string tok;
                if (s.GetToken(tok))
-                       dat->lastnotify = ConvToInt(tok);
+                       dat->lastnotify = ConvToNum<time_t>(tok);
 
                while (s.GetToken(tok))
                {
                        User *u = ServerInstance->FindNick(tok);
-                       if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
+                       if ((u) && (u->registered == REG_ALL) && (!u->quitting))
                        {
                                if (dat->accepting.insert(u).second)
                                {
@@ -107,10 +120,6 @@ struct CallerIDExtInfo : public ExtensionItem
                                }
                        }
                }
-
-               void* old = set_raw(container, dat);
-               if (old)
-                       this->free(old);
        }
 
        callerid_data* get(User* user, bool create)
@@ -124,7 +133,7 @@ struct CallerIDExtInfo : public ExtensionItem
                return dat;
        }
 
-       void free(void* item)
+       void free(Extensible* container, void* item) CXX11_OVERRIDE
        {
                callerid_data* dat = static_cast<callerid_data*>(item);
 
@@ -146,12 +155,6 @@ struct CallerIDExtInfo : public ExtensionItem
        }
 };
 
-class User_g : public SimpleUserModeHandler
-{
-public:
-       User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
-};
-
 class CommandAccept : public Command
 {
        /** Pair: first is the target, second is true to add, false to remove
@@ -170,7 +173,7 @@ class CommandAccept : public Command
                else
                        target = ServerInstance->FindNickOnly(tok);
 
-               if ((!target) || (target->registered != REG_ALL) || (target->quitting) || (IS_SERVER(target)))
+               if ((!target) || (target->registered != REG_ALL) || (target->quitting))
                        target = NULL;
 
                return std::make_pair(target, !remove);
@@ -183,17 +186,17 @@ public:
                extInfo(Creator)
        {
                allow_empty_last_param = false;
-               syntax = "*|(+|-)<nick>[,(+|-)<nick> ...]";
+               syntax = "*|(+|-)<nick>[,(+|-)<nick>]+";
                TRANSLATE1(TR_CUSTOM);
        }
 
-       void EncodeParameter(std::string& parameter, int index)
+       void EncodeParameter(std::string& parameter, unsigned int index) CXX11_OVERRIDE
        {
                // Send lists as-is (part of 2.0 compat)
                if (parameter.find(',') != std::string::npos)
                        return;
 
-               // Convert a [+|-]<nick> into a [-]<uuid>
+               // Convert a (+|-)<nick> into a [-]<uuid>
                ACCEPTAction action = GetTargetAndAction(parameter);
                if (!action.first)
                        return;
@@ -201,12 +204,12 @@ public:
                parameter = (action.second ? "" : "-") + action.first->uuid;
        }
 
-       /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
+       /** Will take any number of nicks (up to MaxTargets), which can be separated by commas.
         * - in front of any nick removes, and an * lists. This effectively means you can do:
         * /accept nick1,nick2,nick3,*
         * to add 3 nicks and then show your list
         */
-       CmdResult Handle(const std::vector<std::string> &parameters, User* user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                if (CommandParser::LoopCall(user, this, parameters, 0))
                        return CMD_SUCCESS;
@@ -224,7 +227,7 @@ public:
                ACCEPTAction action = GetTargetAndAction(tok, user);
                if (!action.first)
                {
-                       user->WriteNumeric(ERR_NOSUCHNICK, "%s :No such nick/channel", tok.c_str());
+                       user->WriteNumeric(Numerics::NoSuchNick(tok));
                        return CMD_FAILURE;
                }
 
@@ -239,15 +242,15 @@ public:
                        return (RemoveAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
        }
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                // There is a list in parameters[0] in two cases:
-               // Either when the source is remote, this happens because 2.0 servers send comma seperated uuid lists,
+               // Either when the source is remote, this happens because 2.0 servers send comma separated uuid lists,
                // we don't split those but broadcast them, as before.
                //
                // Or if the source is local then LoopCall() runs OnPostCommand() after each entry in the list,
                // meaning the linking module has sent an ACCEPT already for each entry in the list to the
-               // appropiate server and the ACCEPT with the list of nicks (this) doesn't need to be sent anywhere.
+               // appropriate server and the ACCEPT with the list of nicks (this) doesn't need to be sent anywhere.
                if ((!IS_LOCAL(user)) && (parameters[0].find(',') != std::string::npos))
                        return ROUTE_BROADCAST;
 
@@ -270,7 +273,7 @@ public:
                        for (callerid_data::UserSet::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
                                user->WriteNumeric(RPL_ACCEPTLIST, (*i)->nick);
                }
-               user->WriteNumeric(RPL_ENDOFACCEPT, ":End of ACCEPT list");
+               user->WriteNumeric(RPL_ENDOFACCEPT, "End of ACCEPT list");
        }
 
        bool AddAccept(User* user, User* whotoadd)
@@ -279,12 +282,12 @@ public:
                callerid_data* dat = extInfo.get(user, true);
                if (dat->accepting.size() >= maxaccepts)
                {
-                       user->WriteNumeric(ERR_ACCEPTFULL, ":Accept list is full (limit is %d)", maxaccepts);
+                       user->WriteNumeric(ERR_ACCEPTFULL, InspIRCd::Format("Accept list is full (limit is %d)", maxaccepts));
                        return false;
                }
                if (!dat->accepting.insert(whotoadd).second)
                {
-                       user->WriteNumeric(ERR_ACCEPTEXIST, "%s :is already on your accept list", whotoadd->nick.c_str());
+                       user->WriteNumeric(ERR_ACCEPTEXIST, whotoadd->nick, "is already on your accept list");
                        return false;
                }
 
@@ -302,12 +305,12 @@ public:
                callerid_data* dat = extInfo.get(user, false);
                if (!dat)
                {
-                       user->WriteNumeric(ERR_ACCEPTNOT, "%s :is not on your accept list", whotoremove->nick.c_str());
+                       user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
                        return false;
                }
                if (!dat->accepting.erase(whotoremove))
                {
-                       user->WriteNumeric(ERR_ACCEPTNOT, "%s :is not on your accept list", whotoremove->nick.c_str());
+                       user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
                        return false;
                }
 
@@ -329,13 +332,35 @@ public:
        }
 };
 
-class ModuleCallerID : public Module
+class CallerIDAPIImpl : public CallerID::APIBase
+{
+ private:
+       CallerIDExtInfo& ext;
+
+ public:
+       CallerIDAPIImpl(Module* Creator, CallerIDExtInfo& Ext)
+               : CallerID::APIBase(Creator)
+               , ext(Ext)
+       {
+       }
+
+       bool IsOnAcceptList(User* source, User* target) CXX11_OVERRIDE
+       {
+               callerid_data* dat = ext.get(target, true);
+               return dat->accepting.count(source);
+       }
+};
+
+
+class ModuleCallerID
+       : public Module
+       , public CTCTags::EventListener
 {
        CommandAccept cmd;
-       User_g myumode;
+       CallerIDAPIImpl api;
+       SimpleUserModeHandler myumode;
 
        // Configuration variables:
-       bool operoverride; // Operators can override callerid.
        bool tracknick; // Allow ACCEPT entries to update with nick changes.
        unsigned int notify_cooldown; // Seconds between notifications.
 
@@ -363,30 +388,35 @@ class ModuleCallerID : public Module
        }
 
 public:
-       ModuleCallerID() : cmd(this), myumode(this)
+       ModuleCallerID()
+               : CTCTags::EventListener(this)
+               , cmd(this)
+               , api(this, cmd.extInfo)
+               , myumode(this, "callerid", 'g')
        {
        }
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
+               return Version("Provides user mode g (callerid) which allows users to require that other users are on their whitelist before messaging them.", VF_COMMON | VF_VENDOR);
        }
 
        void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
        {
-               tokens["CALLERID"] = "g";
+               tokens["ACCEPT"] = ConvToStr(cmd.maxaccepts);
+               tokens["CALLERID"] = ConvToStr(myumode.GetModeChar());
        }
 
-       ModResult OnUserPreMessage(User* user, void* voiddest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
+       ModResult HandleMessage(User* user, const MessageTarget& target)
        {
-               if (!IS_LOCAL(user) || target_type != TYPE_USER)
+               if (!IS_LOCAL(user) || target.type != MessageTarget::TYPE_USER)
                        return MOD_RES_PASSTHRU;
 
-               User* dest = static_cast<User*>(voiddest);
+               User* dest = target.Get<User>();
                if (!dest->IsModeSet(myumode) || (user == dest))
                        return MOD_RES_PASSTHRU;
 
-               if (operoverride && user->IsOper())
+               if (user->HasPrivPermission("users/ignore-callerid"))
                        return MOD_RES_PASSTHRU;
 
                callerid_data* dat = cmd.extInfo.get(dest, true);
@@ -394,12 +424,12 @@ public:
                {
                        time_t now = ServerInstance->Time();
                        /* +g and *not* accepted */
-                       user->WriteNumeric(ERR_TARGUMODEG, "%s :is in +g mode (server-side ignore).", dest->nick.c_str());
+                       user->WriteNumeric(ERR_TARGUMODEG, dest->nick, "is in +g mode (server-side ignore).");
                        if (now > (dat->lastnotify + (time_t)notify_cooldown))
                        {
-                               user->WriteNumeric(RPL_TARGNOTIFY, "%s :has been informed that you messaged them.", dest->nick.c_str());
-                               dest->SendText(":%s %03d %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
-                                               ServerInstance->Config->ServerName.c_str(), RPL_UMODEGMSG, dest->nick.c_str(), user->nick.c_str(), user->ident.c_str(), user->dhost.c_str(), user->nick.c_str());
+                               user->WriteNumeric(RPL_TARGNOTIFY, dest->nick, "has been informed that you messaged them.");
+                               dest->WriteRemoteNumeric(RPL_UMODEGMSG, user->nick, InspIRCd::Format("%s@%s", user->ident.c_str(), user->GetDisplayedHost().c_str()), InspIRCd::Format("is messaging you, and you have user mode +g set. Use /ACCEPT +%s to allow.",
+                                               user->nick.c_str()));
                                dat->lastnotify = now;
                        }
                        return MOD_RES_DENY;
@@ -407,6 +437,16 @@ public:
                return MOD_RES_PASSTHRU;
        }
 
+       ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
+       {
+               return HandleMessage(user, target);
+       }
+
+       ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
+       {
+               return HandleMessage(user, target);
+       }
+
        void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE
        {
                if (!tracknick)
@@ -421,10 +461,9 @@ public:
        void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
                ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
-               cmd.maxaccepts = tag->getInt("maxaccepts", 16);
-               operoverride = tag->getBool("operoverride");
+               cmd.maxaccepts = tag->getUInt("maxaccepts", 30);
                tracknick = tag->getBool("tracknick");
-               notify_cooldown = tag->getInt("cooldown", 60);
+               notify_cooldown = tag->getDuration("cooldown", 60);
        }
 
        void Prioritize() CXX11_OVERRIDE