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/>.
28 RPL_ENDOFACCEPT = 282,
30 ERR_ACCEPTEXIST = 457,
42 /** Users I accept messages from
44 std::set<User*> accepting;
46 /** Users who list me as accepted
48 std::list<callerid_data *> wholistsme;
50 callerid_data() : lastnotify(0) { }
52 std::string ToString(SerializeFormat format) const
54 std::ostringstream oss;
56 for (std::set<User*>::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
60 oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
66 struct CallerIDExtInfo : public ExtensionItem
68 CallerIDExtInfo(Module* parent)
69 : ExtensionItem("callerid_data", parent)
73 std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
76 if (format != FORMAT_NETWORK)
78 callerid_data* dat = static_cast<callerid_data*>(item);
79 ret = dat->ToString(format);
84 void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
86 if (format == FORMAT_NETWORK)
89 callerid_data* dat = new callerid_data;
90 irc::commasepstream s(value);
93 dat->lastnotify = ConvToInt(tok);
95 while (s.GetToken(tok))
97 User *u = ServerInstance->FindNick(tok);
98 if ((u) && (u->registered == REG_ALL) && (!u->quitting) && (!IS_SERVER(u)))
100 if (dat->accepting.insert(u).second)
102 callerid_data* other = this->get(u, true);
103 other->wholistsme.push_back(dat);
108 void* old = set_raw(container, dat);
113 callerid_data* get(User* user, bool create)
115 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
118 dat = new callerid_data;
124 void free(void* item)
126 callerid_data* dat = static_cast<callerid_data*>(item);
128 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
129 for (std::set<User *>::iterator it = dat->accepting.begin(); it != dat->accepting.end(); it++)
131 callerid_data *targ = this->get(*it, false);
135 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
136 continue; // shouldn't happen, but oh well.
139 std::list<callerid_data*>::iterator it2 = std::find(targ->wholistsme.begin(), targ->wholistsme.end(), dat);
140 if (it2 != targ->wholistsme.end())
141 targ->wholistsme.erase(it2);
143 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
149 class User_g : public SimpleUserModeHandler
152 User_g(Module* Creator) : SimpleUserModeHandler(Creator, "callerid", 'g') { }
155 class CommandAccept : public Command
157 /** Pair: first is the target, second is true to add, false to remove
159 typedef std::pair<User*, bool> ACCEPTAction;
161 static ACCEPTAction GetTargetAndAction(std::string& tok)
163 bool remove = (tok[0] == '-');
164 if ((remove) || (tok[0] == '+'))
165 tok.erase(tok.begin());
167 User* target = ServerInstance->FindNick(tok);
168 if ((!target) || (target->registered != REG_ALL) || (target->quitting) || (IS_SERVER(target)))
171 return std::make_pair(target, !remove);
175 CallerIDExtInfo extInfo;
176 unsigned int maxaccepts;
177 CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
180 allow_empty_last_param = false;
181 syntax = "{[+|-]<nicks>}|*}";
182 TRANSLATE1(TR_CUSTOM);
185 void EncodeParameter(std::string& parameter, int index)
187 // Send lists as-is (part of 2.0 compat)
188 if (parameter.find(',') != std::string::npos)
191 // Convert a [+|-]<nick> into a [-]<uuid>
192 ACCEPTAction action = GetTargetAndAction(parameter);
196 parameter = (action.second ? "" : "-") + action.first->uuid;
199 /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
200 * - in front of any nick removes, and an * lists. This effectively means you can do:
201 * /accept nick1,nick2,nick3,*
202 * to add 3 nicks and then show your list
204 CmdResult Handle(const std::vector<std::string> ¶meters, User* user)
206 if (CommandParser::LoopCall(user, this, parameters, 0))
209 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
210 * have a list already setup. */
212 if (parameters[0] == "*")
218 std::string tok = parameters[0];
219 ACCEPTAction action = GetTargetAndAction(tok);
222 user->WriteNumeric(ERR_NOSUCHNICK, "%s :No such nick/channel", tok.c_str());
226 if ((!IS_LOCAL(user)) && (!IS_LOCAL(action.first)))
227 // Neither source nor target is local, forward the command to the server of target
230 // The second item in the pair is true if the first char is a '+' (or nothing), false if it's a '-'
232 return (AddAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
234 return (RemoveAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
237 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
239 // There is a list in parameters[0] in two cases:
240 // Either when the source is remote, this happens because 2.0 servers send comma seperated uuid lists,
241 // we don't split those but broadcast them, as before.
243 // Or if the source is local then LoopCall() runs OnPostCommand() after each entry in the list,
244 // meaning the linking module has sent an ACCEPT already for each entry in the list to the
245 // appropiate server and the ACCEPT with the list of nicks (this) doesn't need to be sent anywhere.
246 if ((!IS_LOCAL(user)) && (parameters[0].find(',') != std::string::npos))
247 return ROUTE_BROADCAST;
250 std::string targetstring = parameters[0];
251 ACCEPTAction action = GetTargetAndAction(targetstring);
253 // Target is a "*" or source is local and the target is a list of nicks
254 return ROUTE_LOCALONLY;
256 // Route to the server of the target
257 return ROUTE_UNICAST(action.first->server);
260 void ListAccept(User* user)
262 callerid_data* dat = extInfo.get(user, false);
265 for (std::set<User*>::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
266 user->WriteNumeric(RPL_ACCEPTLIST, (*i)->nick);
268 user->WriteNumeric(RPL_ENDOFACCEPT, ":End of ACCEPT list");
271 bool AddAccept(User* user, User* whotoadd)
273 // Add this user to my accept list first, so look me up..
274 callerid_data* dat = extInfo.get(user, true);
275 if (dat->accepting.size() >= maxaccepts)
277 user->WriteNumeric(ERR_ACCEPTFULL, ":Accept list is full (limit is %d)", maxaccepts);
280 if (!dat->accepting.insert(whotoadd).second)
282 user->WriteNumeric(ERR_ACCEPTEXIST, "%s :is already on your accept list", whotoadd->nick.c_str());
286 // Now, look them up, and add me to their list
287 callerid_data *targ = extInfo.get(whotoadd, true);
288 targ->wholistsme.push_back(dat);
290 user->WriteNotice(whotoadd->nick + " is now on your accept list");
294 bool RemoveAccept(User* user, User* whotoremove)
296 // Remove them from my list, so look up my list..
297 callerid_data* dat = extInfo.get(user, false);
300 user->WriteNumeric(ERR_ACCEPTNOT, "%s :is not on your accept list", whotoremove->nick.c_str());
303 std::set<User*>::iterator i = dat->accepting.find(whotoremove);
304 if (i == dat->accepting.end())
306 user->WriteNumeric(ERR_ACCEPTNOT, "%s :is not on your accept list", whotoremove->nick.c_str());
310 dat->accepting.erase(i);
312 // Look up their list to remove me.
313 callerid_data *dat2 = extInfo.get(whotoremove, false);
316 // How the fuck is this possible.
317 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
321 std::list<callerid_data*>::iterator it = std::find(dat2->wholistsme.begin(), dat2->wholistsme.end(), dat);
322 if (it != dat2->wholistsme.end())
324 dat2->wholistsme.erase(it);
326 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
329 user->WriteNotice(whotoremove->nick + " is no longer on your accept list");
334 class ModuleCallerID : public Module
339 // Configuration variables:
340 bool operoverride; // Operators can override callerid.
341 bool tracknick; // Allow ACCEPT entries to update with nick changes.
342 unsigned int notify_cooldown; // Seconds between notifications.
344 /** Removes a user from all accept lists
345 * @param who The user to remove from accepts
347 void RemoveFromAllAccepts(User* who)
349 // First, find the list of people who have me on accept
350 callerid_data *userdata = cmd.extInfo.get(who, false);
354 // Iterate over the list of people who accept me, and remove all entries
355 for (std::list<callerid_data *>::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); it++)
357 callerid_data *dat = *(it);
359 // Find me on their callerid list
360 std::set<User *>::iterator it2 = dat->accepting.find(who);
362 if (it2 != dat->accepting.end())
363 dat->accepting.erase(it2);
365 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
368 userdata->wholistsme.clear();
372 ModuleCallerID() : cmd(this), myumode(this)
376 Version GetVersion() CXX11_OVERRIDE
378 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
381 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
383 tokens["CALLERID"] = "g";
386 ModResult PreText(User* user, User* dest, std::string& text)
388 if (!dest->IsModeSet(myumode) || (user == dest))
389 return MOD_RES_PASSTHRU;
391 if (operoverride && user->IsOper())
392 return MOD_RES_PASSTHRU;
394 callerid_data* dat = cmd.extInfo.get(dest, true);
395 std::set<User*>::iterator i = dat->accepting.find(user);
397 if (i == dat->accepting.end())
399 time_t now = ServerInstance->Time();
400 /* +g and *not* accepted */
401 user->WriteNumeric(ERR_TARGUMODEG, "%s :is in +g mode (server-side ignore).", dest->nick.c_str());
402 if (now > (dat->lastnotify + (time_t)notify_cooldown))
404 user->WriteNumeric(RPL_TARGNOTIFY, "%s :has been informed that you messaged them.", dest->nick.c_str());
405 dest->SendText(":%s %03d %s %s %s@%s :is messaging you, and you have umode +g. Use /ACCEPT +%s to allow.",
406 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());
407 dat->lastnotify = now;
411 return MOD_RES_PASSTHRU;
414 ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
416 if (IS_LOCAL(user) && target_type == TYPE_USER)
417 return PreText(user, (User*)dest, text);
419 return MOD_RES_PASSTHRU;
422 void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE
425 RemoveFromAllAccepts(user);
428 void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE
430 RemoveFromAllAccepts(user);
433 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
435 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
436 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
437 operoverride = tag->getBool("operoverride");
438 tracknick = tag->getBool("tracknick");
439 notify_cooldown = tag->getInt("cooldown", 60);
443 MODULE_INIT(ModuleCallerID)