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,
40 typedef insp::flat_set<User*> UserSet;
41 typedef std::vector<callerid_data*> CallerIdDataSet;
45 /** Users I accept messages from
49 /** Users who list me as accepted
51 CallerIdDataSet wholistsme;
53 callerid_data() : lastnotify(0) { }
55 std::string ToString(SerializeFormat format) const
57 std::ostringstream oss;
59 for (UserSet::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
63 oss << "," << (format == FORMAT_USER ? u->nick : u->uuid);
69 struct CallerIDExtInfo : public ExtensionItem
71 CallerIDExtInfo(Module* parent)
72 : ExtensionItem("callerid_data", ExtensionItem::EXT_USER, parent)
76 std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
79 if (format != FORMAT_NETWORK)
81 callerid_data* dat = static_cast<callerid_data*>(item);
82 ret = dat->ToString(format);
87 void unserialize(SerializeFormat format, Extensible* container, const std::string& value)
89 if (format == FORMAT_NETWORK)
92 void* old = get_raw(container);
95 callerid_data* dat = new callerid_data;
96 set_raw(container, dat);
98 irc::commasepstream s(value);
101 dat->lastnotify = ConvToInt(tok);
103 while (s.GetToken(tok))
105 User *u = ServerInstance->FindNick(tok);
106 if ((u) && (u->registered == REG_ALL) && (!u->quitting))
108 if (dat->accepting.insert(u).second)
110 callerid_data* other = this->get(u, true);
111 other->wholistsme.push_back(dat);
117 callerid_data* get(User* user, bool create)
119 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
122 dat = new callerid_data;
128 void free(void* item)
130 callerid_data* dat = static_cast<callerid_data*>(item);
132 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
133 for (callerid_data::UserSet::iterator it = dat->accepting.begin(); it != dat->accepting.end(); ++it)
135 callerid_data *targ = this->get(*it, false);
139 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
140 continue; // shouldn't happen, but oh well.
143 if (!stdalgo::vector::swaperase(targ->wholistsme, dat))
144 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
150 class CommandAccept : public Command
152 /** Pair: first is the target, second is true to add, false to remove
154 typedef std::pair<User*, bool> ACCEPTAction;
156 static ACCEPTAction GetTargetAndAction(std::string& tok, User* cmdfrom = NULL)
158 bool remove = (tok[0] == '-');
159 if ((remove) || (tok[0] == '+'))
160 tok.erase(tok.begin());
163 if (!cmdfrom || !IS_LOCAL(cmdfrom))
164 target = ServerInstance->FindNick(tok);
166 target = ServerInstance->FindNickOnly(tok);
168 if ((!target) || (target->registered != REG_ALL) || (target->quitting))
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 = "*|(+|-)<nick>[,(+|-)<nick> ...]";
182 TRANSLATE1(TR_CUSTOM);
185 void EncodeParameter(std::string& parameter, unsigned 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, user);
222 user->WriteNumeric(Numerics::NoSuchNick(tok));
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, user);
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 (callerid_data::UserSet::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, InspIRCd::Format("Accept list is full (limit is %d)", maxaccepts));
280 if (!dat->accepting.insert(whotoadd).second)
282 user->WriteNumeric(ERR_ACCEPTEXIST, whotoadd->nick, "is already on your accept list");
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, whotoremove->nick, "is not on your accept list");
303 if (!dat->accepting.erase(whotoremove))
305 user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
309 // Look up their list to remove me.
310 callerid_data *dat2 = extInfo.get(whotoremove, false);
313 // How the fuck is this possible.
314 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
318 if (!stdalgo::vector::swaperase(dat2->wholistsme, dat))
319 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
322 user->WriteNotice(whotoremove->nick + " is no longer on your accept list");
327 class ModuleCallerID : public Module
330 SimpleUserModeHandler myumode;
332 // Configuration variables:
333 bool operoverride; // Operators can override callerid.
334 bool tracknick; // Allow ACCEPT entries to update with nick changes.
335 unsigned int notify_cooldown; // Seconds between notifications.
337 /** Removes a user from all accept lists
338 * @param who The user to remove from accepts
340 void RemoveFromAllAccepts(User* who)
342 // First, find the list of people who have me on accept
343 callerid_data *userdata = cmd.extInfo.get(who, false);
347 // Iterate over the list of people who accept me, and remove all entries
348 for (callerid_data::CallerIdDataSet::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); ++it)
350 callerid_data *dat = *(it);
352 // Find me on their callerid list
353 if (!dat->accepting.erase(who))
354 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
357 userdata->wholistsme.clear();
363 , myumode(this, "callerid", 'g')
367 Version GetVersion() CXX11_OVERRIDE
369 return Version("Implementation of callerid, usermode +g, /accept", VF_COMMON | VF_VENDOR);
372 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
374 tokens["CALLERID"] = "g";
377 ModResult OnUserPreMessage(User* user, void* voiddest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
379 if (!IS_LOCAL(user) || target_type != TYPE_USER)
380 return MOD_RES_PASSTHRU;
382 User* dest = static_cast<User*>(voiddest);
383 if (!dest->IsModeSet(myumode) || (user == dest))
384 return MOD_RES_PASSTHRU;
386 if (operoverride && user->IsOper())
387 return MOD_RES_PASSTHRU;
389 callerid_data* dat = cmd.extInfo.get(dest, true);
390 if (!dat->accepting.count(user))
392 time_t now = ServerInstance->Time();
393 /* +g and *not* accepted */
394 user->WriteNumeric(ERR_TARGUMODEG, dest->nick, "is in +g mode (server-side ignore).");
395 if (now > (dat->lastnotify + (time_t)notify_cooldown))
397 user->WriteNumeric(RPL_TARGNOTIFY, dest->nick, "has been informed that you messaged them.");
398 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 umode +g. Use /ACCEPT +%s to allow.",
399 user->nick.c_str()));
400 dat->lastnotify = now;
404 return MOD_RES_PASSTHRU;
407 void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE
410 RemoveFromAllAccepts(user);
413 void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE
415 RemoveFromAllAccepts(user);
418 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
420 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
421 cmd.maxaccepts = tag->getInt("maxaccepts", 16);
422 operoverride = tag->getBool("operoverride");
423 tracknick = tag->getBool("tracknick");
424 notify_cooldown = tag->getDuration("cooldown", 60);
427 void Prioritize() CXX11_OVERRIDE
429 // Want to be after modules like silence or services_account
430 ServerInstance->Modules->SetPriority(this, I_OnUserPreMessage, PRIORITY_LAST);
434 MODULE_INIT(ModuleCallerID)