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 callerid_data* dat = new callerid_data;
72 irc::commasepstream s(value);
75 dat->lastnotify = ConvToInt(tok);
77 while (s.GetToken(tok))
82 User *u = ServerInstance->FindNick(tok);
83 if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
85 if (dat->accepting.insert(u).second)
87 callerid_data* other = this->get(u, true);
88 other->wholistsme.push_back(dat);
93 void* old = set_raw(container, dat);
98 callerid_data* get(User* user, bool create)
100 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
103 dat = new callerid_data;
109 void free(void* item)
111 callerid_data* dat = static_cast<callerid_data*>(item);
113 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
114 for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
116 callerid_data *targ = this->get(*it, false);
120 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
121 continue; // shouldn't happen, but oh well.
124 std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
125 if (it2 != targ->wholistsme.end())
126 targ->wholistsme.erase(it2);
128 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
134 class User_g : public SimpleUserModeHandler
137 User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
140 class CommandAccept : public Command
143 CallerIDExtInfo extInfo;
144 unsigned int maxaccepts;
145 CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
148 allow_empty_last_param = false;
149 syntax = "{[+|-]<nicks>}|*}";
150 TRANSLATE2(TR_CUSTOM, TR_END);
153 virtual void EncodeParameter(std::string& parameter, int index)
158 irc::commasepstream nicks(parameter);
160 while (nicks.GetToken(tok))
164 continue; // Drop list requests, since remote servers ignore them anyway.
172 tok.erase(0, 1); // Remove the dash.
174 User* u = ServerInstance->FindNick(tok);
175 if ((!u) || (u->registered != REG_ALL) || (u->quitting) || (IS_SERVER(u)))
185 /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
186 * - in front of any nick removes, and an * lists. This effectively means you can do:
187 * /accept nick1,nick2,nick3,*
188 * to add 3 nicks and then show your list
190 CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
192 if (ServerInstance->Parser->LoopCall(user, this, parameters, 0))
194 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
195 * have a list already setup. */
197 std::string tok = parameters[0];
205 else if (tok[0] == '-')
207 User* whotoremove = ServerInstance->FindNick(tok.substr(1));
209 return (RemoveAccept(user, whotoremove) ? CMD_SUCCESS : CMD_FAILURE);
215 User* whotoadd = ServerInstance->FindNick(tok[0] == '+' ? tok.substr(1) : tok);
216 if ((whotoadd) && (whotoadd->registered == REG_ALL) && (!whotoadd->quitting) && (!IS_SERVER(whotoadd)))
217 return (AddAccept(user, whotoadd) ? CMD_SUCCESS : CMD_FAILURE);
220 user->WriteNumeric(401, "%s %s :No such nick/channel", user->nick.c_str(), tok.c_str());
226 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
228 return ROUTE_BROADCAST;
231 void ListAccept(User* user)
233 callerid_data* dat = extInfo.get(user, false);
236 for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
237 user->WriteNumeric(281, "%s %s", user->nick.c_str(), (*i)->nick.c_str());
239 user->WriteNumeric(282, "%s :End of ACCEPT list", user->nick.c_str());
242 bool AddAccept(User* user, User* whotoadd)
244 // Add this user to my accept list first, so look me up..
245 callerid_data* dat = extInfo.get(user, true);
246 if (dat->accepting.size() >= maxaccepts)
248 user->WriteNumeric(456, "%s :Accept list is full (limit is %d)", user->nick.c_str(), maxaccepts);
251 if (!dat->accepting.insert(whotoadd).second)
253 user->WriteNumeric(457, "%s %s :is already on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
257 // Now, look them up, and add me to their list
258 callerid_data *targ = extInfo.get(whotoadd, true);
259 targ->wholistsme.push_back(dat);
261 user->WriteServ("NOTICE %s :%s is now on your accept list", user->nick.c_str(), whotoadd->nick.c_str());
265 bool RemoveAccept(User* user, User* whotoremove)
267 // Remove them from my list, so look up my list..
268 callerid_data* dat = extInfo.get(user, false);
271 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
274 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
275 if (i == dat->accepting.end())
277 user->WriteNumeric(458, "%s %s :is not on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
281 dat->accepting.erase(i);
283 // Look up their list to remove me.
284 callerid_data *dat2 = extInfo.get(whotoremove, false);
287 // How the fuck is this possible.
288 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
292 std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
293 if (it != dat2->wholistsme.end())
295 dat2->wholistsme.erase(it);
297 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
300 user->WriteServ("NOTICE %s :%s is no longer on your accept list", user->nick.c_str(), whotoremove->nick.c_str());
305 class ModuleCallerID : public Module
311 // Configuration variables:
312 bool operoverride; // Operators can override callerid.
313 bool tracknick; // Allow ACCEPT entries to update with nick changes.
314 unsigned int notify_cooldown; // Seconds between notifications.
316 /** Removes a user from all accept lists
317 * @param who The user to remove from accepts
319 void RemoveFromAllAccepts(User* who)
321 // First, find the list of people who have me on accept
322 callerid_data *userdata = cmd.extInfo.get(who, false);
326 // Iterate over the list of people who accept me, and remove all entries
327 for (std::list<callerid_data *>::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); it++)
329 callerid_data *dat = *(it);
331 // Find me on their callerid list
332 std::set<User *>::iterator it2 = dat->accepting.find(who);
334 if (it2 != dat->accepting.end())
335 dat->accepting.erase(it2);
337 ServerInstance->Logs->Log("m_callerid", DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
340 userdata->wholistsme.clear();
344 ModuleCallerID() : cmd(this), myumode(this)
352 ServerInstance->Modules->AddService(myumode);
353 ServerInstance->Modules->AddService(cmd);
354 ServerInstance->Modules->AddService(cmd.extInfo);
356 Implementation eventlist[] = { I_OnRehash, I_OnUserPostNick, I_OnUserQuit, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage };
357 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
360 virtual ~ModuleCallerID()
364 virtual Version GetVersion()
366 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
369 virtual void On005Numeric(std::string& output)
371 output += " CALLERID=g";
374 ModResult PreText(User* user, User* dest, std::string& text)
376 if (!dest->IsModeSet('g') || (user == dest))
377 return MOD_RES_PASSTHRU;
379 if (operoverride && IS_OPER(user))
380 return MOD_RES_PASSTHRU;
382 callerid_data* dat = cmd.extInfo.get(dest, true);
383 std::set<User*>::iterator i = dat->accepting.find(user);
385 if (i == dat->accepting.end())
387 time_t now = ServerInstance->Time();
388 /* +g and *not* accepted */
389 user->WriteNumeric(716, "%s %s :is in +g mode (server-side ignore).", user->nick.c_str(), dest->nick.c_str());
390 if (now > (dat->lastnotify + (time_t)notify_cooldown))
392 user->WriteNumeric(717, "%s %s :has been informed that you messaged them.", user->nick.c_str(), dest->nick.c_str());
393 dest->SendText(":%s 718 %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
394 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());
395 dat->lastnotify = now;
399 return MOD_RES_PASSTHRU;
402 virtual ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
404 if (IS_LOCAL(user) && target_type == TYPE_USER)
405 return PreText(user, (User*)dest, text);
407 return MOD_RES_PASSTHRU;
410 virtual ModResult OnUserPreNotice(User* user, void* dest, int target_type, std::string& text, char status, CUList &exempt_list)
412 if (IS_LOCAL(user) && target_type == TYPE_USER)
413 return PreText(user, (User*)dest, text);
415 return MOD_RES_PASSTHRU;
418 void OnUserPostNick(User* user, const std::string& oldnick)
421 RemoveFromAllAccepts(user);
424 void OnUserQuit(User* user, const std::string& message, const std::string& oper_message)
426 RemoveFromAllAccepts(user);
429 virtual void OnRehash(User* user)
431 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
432 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
433 operoverride = tag->getBool("operoverride");
434 tracknick = tag->getBool("tracknick");
435 notify_cooldown = tag->getInt("cooldown", 60);
439 MODULE_INIT(ModuleCallerID)