2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
7 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
9 * This file is part of InspIRCd. InspIRCd is free software: you can
10 * redistribute it and/or modify it under the terms of the GNU General Public
11 * License as published by the Free Software Foundation, version 2.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 /* $ModDesc: Implementation of callerid, usermode +g, /accept */
32 /** Users I accept messages from
34 std::set<User*> accepting;
36 /** Users who list me as accepted
38 std::list<callerid_data *> wholistsme;
40 callerid_data() : lastnotify(0) { }
42 std::string ToString(SerializeFormat format) const
44 std::ostringstream oss;
46 for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
50 oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
56 struct CallerIDExtInfo : public ExtensionItem
58 CallerIDExtInfo(Module* parent)
59 : ExtensionItem("callerid_data", parent)
63 std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
65 callerid_data* dat = static_cast<callerid_data*>(item);
66 return dat->ToString(format);
69 void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
71 void* old = get_raw(container);
74 callerid_data* dat = new callerid_data;
75 set_raw(container, dat);
77 irc::commasepstream s(value);
80 dat->lastnotify = ConvToInt(tok);
82 while (s.GetToken(tok))
87 User *u = ServerInstance->FindNick(tok);
88 if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
90 if (dat->accepting.insert(u).second)
92 callerid_data* other = this->get(u, true);
93 other->wholistsme.push_back(dat);
99 callerid_data* get(User* user, bool create)
101 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
104 dat = new callerid_data;
110 void free(void* item)
112 callerid_data* dat = static_cast<callerid_data*>(item);
114 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
115 for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
117 callerid_data *targ = this->get(*it, false);
121 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
122 continue; // shouldn't happen, but oh well.
125 std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
126 if (it2 != targ->wholistsme.end())
127 targ->wholistsme.erase(it2);
129 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
135 class User_g : public SimpleUserModeHandler
138 User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
141 class CommandAccept : public Command
144 CallerIDExtInfo extInfo;
145 unsigned int maxaccepts;
146 CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
149 allow_empty_last_param = false;
150 syntax = "*|(+|-)<nick>[,(+|-)<nick> ...]";
151 TRANSLATE2(TR_CUSTOM, TR_END);
154 virtual void EncodeParameter(std::string& parameter, int index)
159 irc::commasepstream nicks(parameter);
161 while (nicks.GetToken(tok))
165 continue; // Drop list requests, since remote servers ignore them anyway.
173 tok.erase(0, 1); // Remove the dash.
175 else if (tok[0] == '+')
178 User* u = ServerInstance->FindNick(tok);
179 if ((!u) || (u->registered != REG_ALL) || (u->quitting) || (IS_SERVER(u)))
189 /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
190 * - in front of any nick removes, and an * lists. This effectively means you can do:
191 * /accept nick1,nick2,nick3,*
192 * to add 3 nicks and then show your list
194 CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
196 if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
198 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
199 * have a list already setup. */
201 const std::string& tok = parameters[0];
209 else if (tok[0] == '-')
213 whotoremove = ServerInstance->FindNickOnly(tok.substr(1));
215 whotoremove = ServerInstance->FindNick(tok.substr(1));
218 return (RemoveAccept(user, whotoremove) ? CMD_SUCCESS : CMD_FAILURE);
224 const std::string target = (tok[0] == '+' ? tok.substr(1) : tok);
227 whotoadd = ServerInstance->FindNickOnly(target);
229 whotoadd = ServerInstance->FindNick(target);
231 if ((whotoadd) && (whotoadd->registered == REG_ALL) && (!whotoadd->quitting) && (!IS_SERVER(whotoadd)))
232 return (AddAccept(user, whotoadd) ? CMD_SUCCESS : CMD_FAILURE);
235 user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
241 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
243 return ROUTE_BROADCAST;
246 void ListAccept(User* user)
248 callerid_data* dat = extInfo.get(user, false);
251 for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
252 user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
254 user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
257 bool AddAccept(User* user, User* whotoadd)
259 // Add this user to my accept list first, so look me up..
260 callerid_data* dat = extInfo.get(user, true);
261 if (dat->accepting.size() >= maxaccepts)
263 user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
266 if (!dat->accepting.insert(whotoadd).second)
268 user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
272 // Now, look them up, and add me to their list
273 callerid_data *targ = extInfo.get(whotoadd, true);
274 targ->wholistsme.push_back(dat);
276 user->WriteServ("NOTICE %s :%s is now on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
280 bool RemoveAccept(User* user, User* whotoremove)
282 // Remove them from my list, so look up my list..
283 callerid_data* dat = extInfo.get(user, false);
286 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
289 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
290 if (i == dat->accepting.end())
292 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
296 dat->accepting.erase(i);
298 // Look up their list to remove me.
299 callerid_data *dat2 = extInfo.get(whotoremove, false);
302 // How the fuck is this possible.
303 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
307 std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
308 if (it != dat2->wholistsme.end())
310 dat2->wholistsme.erase(it);
312 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
315 user->WriteServ("NOTICE %s :%s is no longer on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
320 class ModuleCallerID : public Module
326 // Configuration variables:
327 bool operoverride; // Operators can override callerid.
328 bool tracknick; // Allow ACCEPT entries to update with nick changes.
329 unsigned int notify_cooldown; // Seconds between notifications.
331 /** Removes a user from all accept lists
332 * @param who The user to remove from accepts
334 void RemoveFromAllAccepts(User* who)
336 // First, find the list of people who have me on accept
337 callerid_data *userdata = cmd.extInfo.get(who, false);
341 // Iterate over the list of people who accept me, and remove all entries
342 for (std::list<callerid_data *>::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); it++)
344 callerid_data *dat = *(it);
346 // Find me on their callerid list
347 std::set<User *>::iterator it2 = dat->accepting.find(who);
349 if (it2 != dat->accepting.end())
350 dat->accepting.erase(it2);
352 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
355 userdata->wholistsme.clear();
359 ModuleCallerID() : cmd(this), myumode(this)
367 ServerInstance->Modules->AddService(myumode);
368 ServerInstance->Modules->AddService(cmd);
369 ServerInstance->Modules->AddService(cmd.extInfo);
371 Implementation eventlist[] = { I_OnRehash, I_OnUserPostNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
372 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
375 virtual ~ModuleCallerID()
379 virtual Version GetVersion()
381 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
384 virtual void On005Numeric(std::string& output)
386 output += " CALLERID=g";
389 ModResult PreText(User* user, User* dest, std::string& text)
391 if (!dest->IsModeSet('g') || (user == dest))
392 return MOD_RES_PASSTHRU;
394 if (operoverride && IS_OPER(user))
395 return MOD_RES_PASSTHRU;
397 callerid_data* dat = cmd.extInfo.get(dest, true);
398 std::set<User*>::iterator i = dat->accepting.find(user);
400 if (i == dat->accepting.end())
402 time_t now = ServerInstance->Time();
403 /* +g and *not* accepted */
404 user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
405 if (now > (dat->lastnotify + (time_t)notify_cooldown))
407 user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
408 dest->SendText(":%s 718 %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
409 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());
410 dat->lastnotify = now;
414 return MOD_RES_PASSTHRU;
417 virtual ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
419 if (IS_LOCAL(user) && target_type == TYPE_USER)
420 return PreText(user, (User*)dest, text);
422 return MOD_RES_PASSTHRU;
425 virtual ModResult OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
427 if (IS_LOCAL(user) && target_type == TYPE_USER)
428 return PreText(user, (User*)dest, text);
430 return MOD_RES_PASSTHRU;
433 void OnUserPostNick(User* user, const std::string& oldnick)
436 RemoveFromAllAccepts(user);
439 void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
441 RemoveFromAllAccepts(user);
444 virtual void OnRehash(User* user)
446 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
447 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
448 operoverride = tag->getBool("operoverride");
449 tracknick = tag->getBool("tracknick");
450 notify_cooldown = tag->getInt("cooldown", 60);
454 MODULE_INIT(ModuleCallerID)