-#include "inspircd.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * 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 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 <set>
+#include "inspircd.h"
-/* $ModDesc: Implementation of callerid (umode +g & /accept, ala hybrid etc) */
+/* $ModDesc: Implementation of callerid, usermode +g, /accept */
class callerid_data
{
public:
time_t lastnotify;
+
+ /** Users I accept messages from
+ */
std::set<User*> accepting;
-};
-callerid_data* GetData(User* who, bool extend = true)
-{
- callerid_data* dat;
- if (who->GetExt("callerid_data", dat))
- {
- return dat;
- }
- else
+ /** Users who list me as accepted
+ */
+ std::list<callerid_data *> wholistsme;
+
+ callerid_data() : lastnotify(0) { }
+ callerid_data(const std::string& str)
{
- if (extend)
+ irc::commasepstream s(str);
+ std::string tok;
+ if (s.GetToken(tok))
{
- dat = new callerid_data;
- dat->lastnotify = 0; // Can't init in struct.
- who->Extend("callerid_data", dat);
- return dat;
+ lastnotify = ConvToInt(tok);
}
- else
+ while (s.GetToken(tok))
{
- return NULL;
+ if (tok.empty())
+ {
+ continue;
+ }
+
+ User *u = ServerInstance->FindNick(tok);
+ if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
+ accepting.insert(u);
}
}
-}
-void RemoveData(User* who)
-{
- callerid_data* dat;
- who->GetExt("callerid_data", dat);
- if (!dat) return;
- who->Shrink("callerid_data");
- delete dat;
-}
-
-void RemoveFromAllAccepts(InspIRCd* ServerInstance, User* who)
-{
- for (user_hash::iterator i = ServerInstance->Users->clientlist->begin(); i != ServerInstance->Users->clientlist->end(); ++i)
+ std::string ToString(SerializeFormat format) const
{
- callerid_data* dat = GetData(i->second, false);
- if (!dat) continue;
- std::set<User*>& accepting = dat->accepting;
- std::set<User*>::iterator iter = accepting.find(who);
- if (iter == accepting.end()) continue;
- accepting.erase(iter);
+ std::ostringstream oss;
+ oss << lastnotify;
+ for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
+ {
+ User* u = *i;
+ // Encode UIDs.
+ oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
+ }
+ return oss.str();
}
-}
+};
-class User_g : public ModeHandler
+struct CallerIDExtInfo : public ExtensionItem
{
-private:
+ CallerIDExtInfo(Module* parent)
+ : ExtensionItem("callerid_data", parent)
+ {
+ }
-public:
- User_g(InspIRCd* Instance) : ModeHandler(Instance, 'g', 0, 0, false, MODETYPE_USER, false) { }
+ 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(value);
+ set_raw(container, dat);
+ }
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding, bool)
+ callerid_data* get(User* user, bool create)
{
- if (adding != dest->IsModeSet('g'))
+ callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
+ if (create && !dat)
{
- dest->SetMode('g', adding);
- return MODEACTION_ALLOW;
+ dat = new callerid_data;
+ set_raw(user, dat);
+ }
+ return dat;
+ }
+
+ void free(void* item)
+ {
+ callerid_data* dat = static_cast<callerid_data*>(item);
+
+ // 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++)
+ {
+ callerid_data *targ = this->get(*it, false);
+
+ if (!targ)
+ 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);
}
- return MODEACTION_DENY;
}
};
+class User_g : public SimpleUserModeHandler
+{
+public:
+ 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>}|*}";
+ TRANSLATE2(TR_CUSTOM, TR_END);
}
- /* Will take any number of nicks, which can be seperated by spaces, commas, or a mix.
+ virtual void EncodeParameter(std::string& parameter, int index)
+ {
+ if (index != 0)
+ return;
+ std::string out = "";
+ irc::commasepstream nicks(parameter);
+ std::string tok;
+ while (nicks.GetToken(tok))
+ {
+ if (tok == "*")
+ {
+ continue; // Drop list requests, since remote servers ignore them anyway.
+ }
+ if (!out.empty())
+ out.append(",");
+ bool dash = false;
+ if (tok[0] == '-')
+ {
+ dash = true;
+ tok.erase(0, 1); // Remove the dash.
+ }
+ User* u = ServerInstance->FindNick(tok);
+ if ((!u) || (u->registered != REG_ALL) || (u->quitting) || (IS_SERVER(u)))
+ continue;
+
+ if (dash)
+ out.append("-");
+ out.append(u->uuid);
+ }
+ parameter = out;
+ }
+
+ /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
* - in front of any nick removes, and an * lists. This effectively means you can do:
- * /accept nick1,nick2,nick3 *
+ * /accept nick1,nick2,nick3,*
* to add 3 nicks and then show your list
*/
- CmdResult Handle(const char* const* parameters, int pcnt, User* user)
+ CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
{
- if (pcnt < 1)
- {
- /* Command stuff should've dealt with this already */
- return CMD_FAILURE;
- }
+ if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
+ return CMD_SUCCESS;
/* 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. */
- bool atleastonechange = false;
- for (int i = 0; i < pcnt; ++i)
+
+ std::string tok = parameters[0];
+
+ if (tok == "*")
{
- const char* arg = parameters[i];
- irc::commasepstream css(arg);
- std::string tok;
- while (css.GetToken(tok))
+ if (IS_LOCAL(user))
+ ListAccept(user);
+ return CMD_SUCCESS;
+ }
+ else if (tok[0] == '-')
+ {
+ User* whotoremove = ServerInstance->FindNick(tok.substr(1));
+ if (whotoremove)
+ 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) && (whotoadd->registered == REG_ALL) && (!whotoadd->quitting) && (!IS_SERVER(whotoadd)))
+ return (AddAccept(user, whotoadd) ? CMD_SUCCESS : CMD_FAILURE);
+ else
{
- if (tok.length() < 1)
- continue;
- if (tok == "*")
- {
- if (IS_LOCAL(user)) continue;
- ListAccept(user);
- }
- else if (tok[0] == '-')
- {
- User* whotoremove = ServerInstance->FindNick(tok.substr(1));
- if (whotoremove)
- {
- atleastonechange = RemoveAccept(user, whotoremove, false) || atleastonechange;
- }
- }
- else
- {
- User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
- if (whotoadd)
- {
- atleastonechange = AddAccept(user, whotoadd, false) || atleastonechange;
- }
- else
- {
- user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick, tok.c_str());
- }
- }
+ user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
+ return CMD_FAILURE;
}
}
- return atleastonechange ? CMD_FAILURE : CMD_SUCCESS;
+ }
+
+ 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)
- {
- user->WriteNumeric(281, "%s %s", user->nick, (*i)->nick);
- }
+ user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
}
- user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick);
+ 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)
{
- callerid_data* dat = GetData(user, true);
- std::set<User*>& accepting = dat->accepting;
- if (accepting.size() >= maxaccepts)
+ // Add this user to my accept list first, so look me up..
+ 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, maxaccepts);
+ user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
return false;
}
- if (!accepting.insert(whotoadd).second)
+ if (!dat->accepting.insert(whotoadd).second)
{
- if (!quiet) user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick, whotoadd->nick);
+ 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 = 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)
{
- callerid_data* dat = GetData(user, false);
+ // Remove them from my list, so look up my list..
+ callerid_data* dat = extInfo.get(user, false);
if (!dat)
{
- if (!quiet) user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick, whotoremove->nick);
+ user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
return false;
}
- std::set<User*>& accepting = dat->accepting;
- std::set<User*>::iterator i = accepting.find(whotoremove);
- if (i == accepting.end())
+ 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, whotoremove->nick);
+ user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
return false;
}
- accepting.erase(i);
+
+ dat->accepting.erase(i);
+
+ // Look up their list to remove me.
+ callerid_data *dat2 = extInfo.get(whotoremove, false);
+ if (!dat2)
+ {
+ // How the fuck is this possible.
+ return false;
+ }
+
+ std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
+ if (it != dat2->wholistsme.end())
+ // Found me!
+ dat2->wholistsme.erase(it);
+
+ user->WriteServ("NOTICE %s :%s is no longer on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
return true;
}
};
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.
-public:
- ModuleCallerID(InspIRCd* Me) : Module(Me)
+ /** Removes a user from all accept lists
+ * @param who The user to remove from accepts
+ */
+ void RemoveFromAllAccepts(User* who)
{
- OnRehash(NULL, "");
- mycommand = new CommandAccept(ServerInstance, maxaccepts);
- myumode = new User_g(ServerInstance);
- try {
- ServerInstance->AddCommand(mycommand);
- } catch (const ModuleException& e) {
- delete mycommand;
- throw;
- }
- if (!ServerInstance->Modes->AddMode(myumode))
+ // First, find the list of people who have me on accept
+ callerid_data *userdata = cmd.extInfo.get(who, false);
+ if (!userdata)
+ return;
+
+ // Iterate over the list of people who accept me, and remove all entries
+ for (std::list<callerid_data *>::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); it++)
{
- delete mycommand;
- delete myumode;
- throw new ModuleException("Could not add usermode and command!");
+ callerid_data *dat = *(it);
+
+ // Find me on their callerid list
+ std::set<User *>::iterator it2 = dat->accepting.find(who);
+
+ if (it2 != dat->accepting.end())
+ dat->accepting.erase(it2);
}
- Implementation eventlist[] = { I_OnRehash, I_OnUserPreNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnCleanup };
- ServerInstance->Modules->Attach(eventlist, this, 7);
+
+ userdata->wholistsme.clear();
+ }
+
+public:
+ ModuleCallerID() : cmd(this), myumode(this)
+ {
+ }
+
+ void init()
+ {
+ OnRehash(NULL);
+
+ ServerInstance->Modules->AddService(myumode);
+ ServerInstance->Modules->AddService(cmd);
+ ServerInstance->Modules->AddService(cmd.extInfo);
+
+ Implementation eventlist[] = { I_OnRehash, I_OnUserPostNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
+ ServerInstance->Modules->Attach(eventlist, this, 6);
}
- ~ModuleCallerID()
+ virtual ~ModuleCallerID()
{
- delete myumode;
}
- Version GetVersion()
+ virtual Version GetVersion()
{
- return Version(1, 0, 0, 0, VF_COMMON | VF_VENDOR, API_VERSION);
+ return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
}
- void On005Numeric(std::string& output)
+ virtual void On005Numeric(std::string& output)
{
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 (operoverride && IS_OPER(user)) return 0;
- callerid_data* dat = GetData(dest, true);
- std::set<User*>& accepting = dat->accepting;
- time_t& lastnotify = dat->lastnotify;
- std::set<User*>::iterator i = accepting.find(dest);
- if (i == accepting.end())
+ if (!dest->IsModeSet('g'))
+ return MOD_RES_PASSTHRU;
+
+ if (operoverride && IS_OPER(user))
+ return MOD_RES_PASSTHRU;
+
+ callerid_data* dat = cmd.extInfo.get(dest, true);
+ std::set<User*>::iterator i = dat->accepting.find(user);
+
+ if (i == dat->accepting.end())
{
- time_t now = time(NULL);
+ time_t now = ServerInstance->Time();
/* +g and *not* accepted */
- user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick, dest->nick);
- if (now > (lastnotify + (time_t)notify_cooldown))
+ user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
+ if (now > (dat->lastnotify + (time_t)notify_cooldown))
{
- user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick, dest->nick);
- dest->WriteNumeric(718, "%s %s %s@%s :is messaging you, and you have umode +g", dest->nick, user->nick, user->ident, user->dhost);
- lastnotify = now;
+ user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
+ 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;
}
- 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 0;
+ return PreText(user, (User*)dest, text);
+
+ return MOD_RES_PASSTHRU;
}
- 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 0;
- }
+ return PreText(user, (User*)dest, text);
- 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);
+ return MOD_RES_PASSTHRU;
}
- int OnUserPreNick(User* user, const std::string& newnick)
+ void OnUserPostNick(User* user, const std::string& oldnick)
{
if (!tracknick)
- RemoveFromAllAccepts(ServerInstance, user);
- return 0;
+ RemoveFromAllAccepts(user);
}
void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
{
- RemoveData(user);
- RemoveFromAllAccepts(ServerInstance, user);
+ RemoveFromAllAccepts(user);
}
- void OnRehash(User* user, const std::string& parameter)
+ virtual void OnRehash(User* user)
{
- ConfigReader Conf(ServerInstance);
- int new_maxaccepts, new_cooldown;
- bool new_override, new_track;
- new_maxaccepts = Conf.ReadInteger("callerid", "maxaccepts", "16", 0, true);
- switch (Conf.GetError())
- {
- case 0: break;
- case CONF_VALUE_NOT_FOUND:
- new_maxaccepts = 16;
- break;
- case CONF_NOT_A_NUMBER:
- if (user) user->WriteServ("NOTICE %s :Invalid maxaccepts value '%s', not a number", user->nick, Conf.ReadValue("callerid", "maxaccepts", "", 0).c_str());
- throw ModuleException("Invalid maxaccepts value, not a number");
- case CONF_INT_NEGATIVE:
- if (user) user->WriteServ("NOTICE %s :Invalid maxaccepts value '%s', negative", user->nick, Conf.ReadValue("callerid", "maxaccepts", "", 0).c_str());
- throw ModuleException("Invalid maxaccepts value, negative");
- default:
- /* Yikes */
- throw ModuleException("Invalid maxaccepts value, unknown config error");
- }
- new_override = Conf.ReadFlag("callerid", "operoverride", "0", 0);
- if (Conf.GetError() == CONF_VALUE_NOT_FOUND) new_override = false;
- new_track = Conf.ReadFlag("callerid", "tracknick", "0", 0);
- if (Conf.GetError() == CONF_VALUE_NOT_FOUND) new_track = false;
- new_cooldown = Conf.ReadInteger("callerid", "cooldown", "60", 0, true);
- switch (Conf.GetError())
- {
- case 0: break;
- case CONF_VALUE_NOT_FOUND:
- new_cooldown = 16;
- break;
- case CONF_NOT_A_NUMBER:
- if (user) user->WriteServ("NOTICE %s :Invalid cooldown value '%s', not a number", user->nick, Conf.ReadValue("callerid", "maxaccepts", "", 0).c_str());
- throw ModuleException("Invalid cooldown value, not a number");
- case CONF_INT_NEGATIVE:
- if (user) user->WriteServ("NOTICE %s :Invalid cooldown value '%s', negative", user->nick, Conf.ReadValue("callerid", "maxaccepts", "", 0).c_str());
- throw ModuleException("Invalid cooldown value, negative");
- default:
- /* Yikes */
- throw ModuleException("Invalid cooldown value, unknown config error");
- }
- maxaccepts = new_maxaccepts;
- notify_cooldown = new_cooldown;
- operoverride = new_override;
- tracknick = new_track;
+ ConfigReader Conf;
+ cmd.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);
}
};