2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
5 * Copyright (C) 2013 Adam <Adam@anope.org>
6 * Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
7 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
8 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
9 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
10 * Copyright (C) 2009 John Brooks <special@inspircd.org>
11 * Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
12 * Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
13 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
15 * This file is part of InspIRCd. InspIRCd is free software: you can
16 * redistribute it and/or modify it under the terms of the GNU General Public
17 * License as published by the Free Software Foundation, version 2.
19 * This program is distributed in the hope that it will be useful, but WITHOUT
20 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 #include "modules/callerid.h"
31 #include "modules/ctctags.h"
36 RPL_ENDOFACCEPT = 282,
38 ERR_ACCEPTEXIST = 457,
48 typedef insp::flat_set<User*> UserSet;
49 typedef std::vector<callerid_data*> CallerIdDataSet;
53 /** Users I accept messages from
57 /** Users who list me as accepted
59 CallerIdDataSet wholistsme;
61 callerid_data() : lastnotify(0) { }
63 std::string ToString(bool human) const
65 std::ostringstream oss;
67 for (UserSet::const_iterator i = accepting.begin(); i != accepting.end(); ++i)
71 oss << "," << (human ? u->nick : u->uuid);
77 struct CallerIDExtInfo : public ExtensionItem
79 CallerIDExtInfo(Module* parent)
80 : ExtensionItem("callerid_data", ExtensionItem::EXT_USER, parent)
84 std::string ToHuman(const Extensible* container, void* item) const CXX11_OVERRIDE
86 callerid_data* dat = static_cast<callerid_data*>(item);
87 return dat->ToString(true);
90 std::string ToInternal(const Extensible* container, void* item) const CXX11_OVERRIDE
92 callerid_data* dat = static_cast<callerid_data*>(item);
93 return dat->ToString(false);
96 void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE
98 void* old = get_raw(container);
100 this->free(NULL, old);
101 callerid_data* dat = new callerid_data;
102 set_raw(container, dat);
104 irc::commasepstream s(value);
107 dat->lastnotify = ConvToNum<time_t>(tok);
109 while (s.GetToken(tok))
111 User *u = ServerInstance->FindNick(tok);
112 if ((u) && (u->registered == REG_ALL) && (!u->quitting))
114 if (dat->accepting.insert(u).second)
116 callerid_data* other = this->get(u, true);
117 other->wholistsme.push_back(dat);
123 callerid_data* get(User* user, bool create)
125 callerid_data* dat = static_cast<callerid_data*>(get_raw(user));
128 dat = new callerid_data;
134 void free(Extensible* container, void* item) CXX11_OVERRIDE
136 callerid_data* dat = static_cast<callerid_data*>(item);
138 // We need to walk the list of users on our accept list, and remove ourselves from their wholistsme.
139 for (callerid_data::UserSet::iterator it = dat->accepting.begin(); it != dat->accepting.end(); ++it)
141 callerid_data *targ = this->get(*it, false);
145 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (1)");
146 continue; // shouldn't happen, but oh well.
149 if (!stdalgo::vector::swaperase(targ->wholistsme, dat))
150 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (2)");
156 class CommandAccept : public Command
158 /** Pair: first is the target, second is true to add, false to remove
160 typedef std::pair<User*, bool> ACCEPTAction;
162 static ACCEPTAction GetTargetAndAction(std::string& tok, User* cmdfrom = NULL)
164 bool remove = (tok[0] == '-');
165 if ((remove) || (tok[0] == '+'))
166 tok.erase(tok.begin());
169 if (!cmdfrom || !IS_LOCAL(cmdfrom))
170 target = ServerInstance->FindNick(tok);
172 target = ServerInstance->FindNickOnly(tok);
174 if ((!target) || (target->registered != REG_ALL) || (target->quitting))
177 return std::make_pair(target, !remove);
181 CallerIDExtInfo extInfo;
182 unsigned int maxaccepts;
183 CommandAccept(Module* Creator) : Command(Creator, "ACCEPT", 1),
186 allow_empty_last_param = false;
187 syntax = "*|(+|-)<nick>[,(+|-)<nick>]+";
188 TRANSLATE1(TR_CUSTOM);
191 void EncodeParameter(std::string& parameter, unsigned int index) CXX11_OVERRIDE
193 // Send lists as-is (part of 2.0 compat)
194 if (parameter.find(',') != std::string::npos)
197 // Convert a (+|-)<nick> into a [-]<uuid>
198 ACCEPTAction action = GetTargetAndAction(parameter);
202 parameter = (action.second ? "" : "-") + action.first->uuid;
205 /** Will take any number of nicks (up to MaxTargets), which can be seperated by commas.
206 * - in front of any nick removes, and an * lists. This effectively means you can do:
207 * /accept nick1,nick2,nick3,*
208 * to add 3 nicks and then show your list
210 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
212 if (CommandParser::LoopCall(user, this, parameters, 0))
215 /* Even if callerid mode is not set, we let them manage their ACCEPT list so that if they go +g they can
216 * have a list already setup. */
218 if (parameters[0] == "*")
224 std::string tok = parameters[0];
225 ACCEPTAction action = GetTargetAndAction(tok, user);
228 user->WriteNumeric(Numerics::NoSuchNick(tok));
232 if ((!IS_LOCAL(user)) && (!IS_LOCAL(action.first)))
233 // Neither source nor target is local, forward the command to the server of target
236 // The second item in the pair is true if the first char is a '+' (or nothing), false if it's a '-'
238 return (AddAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
240 return (RemoveAccept(user, action.first) ? CMD_SUCCESS : CMD_FAILURE);
243 RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
245 // There is a list in parameters[0] in two cases:
246 // Either when the source is remote, this happens because 2.0 servers send comma seperated uuid lists,
247 // we don't split those but broadcast them, as before.
249 // Or if the source is local then LoopCall() runs OnPostCommand() after each entry in the list,
250 // meaning the linking module has sent an ACCEPT already for each entry in the list to the
251 // appropiate server and the ACCEPT with the list of nicks (this) doesn't need to be sent anywhere.
252 if ((!IS_LOCAL(user)) && (parameters[0].find(',') != std::string::npos))
253 return ROUTE_BROADCAST;
256 std::string targetstring = parameters[0];
257 ACCEPTAction action = GetTargetAndAction(targetstring, user);
259 // Target is a "*" or source is local and the target is a list of nicks
260 return ROUTE_LOCALONLY;
262 // Route to the server of the target
263 return ROUTE_UNICAST(action.first->server);
266 void ListAccept(User* user)
268 callerid_data* dat = extInfo.get(user, false);
271 for (callerid_data::UserSet::iterator i = dat->accepting.begin(); i != dat->accepting.end(); ++i)
272 user->WriteNumeric(RPL_ACCEPTLIST, (*i)->nick);
274 user->WriteNumeric(RPL_ENDOFACCEPT, "End of ACCEPT list");
277 bool AddAccept(User* user, User* whotoadd)
279 // Add this user to my accept list first, so look me up..
280 callerid_data* dat = extInfo.get(user, true);
281 if (dat->accepting.size() >= maxaccepts)
283 user->WriteNumeric(ERR_ACCEPTFULL, InspIRCd::Format("Accept list is full (limit is %d)", maxaccepts));
286 if (!dat->accepting.insert(whotoadd).second)
288 user->WriteNumeric(ERR_ACCEPTEXIST, whotoadd->nick, "is already on your accept list");
292 // Now, look them up, and add me to their list
293 callerid_data *targ = extInfo.get(whotoadd, true);
294 targ->wholistsme.push_back(dat);
296 user->WriteNotice(whotoadd->nick + " is now on your accept list");
300 bool RemoveAccept(User* user, User* whotoremove)
302 // Remove them from my list, so look up my list..
303 callerid_data* dat = extInfo.get(user, false);
306 user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
309 if (!dat->accepting.erase(whotoremove))
311 user->WriteNumeric(ERR_ACCEPTNOT, whotoremove->nick, "is not on your accept list");
315 // Look up their list to remove me.
316 callerid_data *dat2 = extInfo.get(whotoremove, false);
319 // How the fuck is this possible.
320 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (3)");
324 if (!stdalgo::vector::swaperase(dat2->wholistsme, dat))
325 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (4)");
328 user->WriteNotice(whotoremove->nick + " is no longer on your accept list");
333 class CallerIDAPIImpl : public CallerID::APIBase
336 CallerIDExtInfo& ext;
339 CallerIDAPIImpl(Module* Creator, CallerIDExtInfo& Ext)
340 : CallerID::APIBase(Creator)
345 bool IsOnAcceptList(User* source, User* target) CXX11_OVERRIDE
347 callerid_data* dat = ext.get(target, true);
348 return dat->accepting.count(source);
355 , public CTCTags::EventListener
359 SimpleUserModeHandler myumode;
361 // Configuration variables:
362 bool tracknick; // Allow ACCEPT entries to update with nick changes.
363 unsigned int notify_cooldown; // Seconds between notifications.
365 /** Removes a user from all accept lists
366 * @param who The user to remove from accepts
368 void RemoveFromAllAccepts(User* who)
370 // First, find the list of people who have me on accept
371 callerid_data *userdata = cmd.extInfo.get(who, false);
375 // Iterate over the list of people who accept me, and remove all entries
376 for (callerid_data::CallerIdDataSet::iterator it = userdata->wholistsme.begin(); it != userdata->wholistsme.end(); ++it)
378 callerid_data *dat = *(it);
380 // Find me on their callerid list
381 if (!dat->accepting.erase(who))
382 ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "ERROR: Inconsistency detected in callerid state, please report (5)");
385 userdata->wholistsme.clear();
390 : CTCTags::EventListener(this)
392 , api(this, cmd.extInfo)
393 , myumode(this, "callerid", 'g')
397 Version GetVersion() CXX11_OVERRIDE
399 return Version("Implementation of callerid, provides user mode +g and the ACCEPT command", VF_COMMON | VF_VENDOR);
402 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
404 tokens["ACCEPT"] = ConvToStr(cmd.maxaccepts);
405 tokens["CALLERID"] = ConvToStr(myumode.GetModeChar());
408 ModResult HandleMessage(User* user, const MessageTarget& target)
410 if (!IS_LOCAL(user) || target.type != MessageTarget::TYPE_USER)
411 return MOD_RES_PASSTHRU;
413 User* dest = target.Get<User>();
414 if (!dest->IsModeSet(myumode) || (user == dest))
415 return MOD_RES_PASSTHRU;
417 if (user->HasPrivPermission("users/ignore-callerid"))
418 return MOD_RES_PASSTHRU;
420 callerid_data* dat = cmd.extInfo.get(dest, true);
421 if (!dat->accepting.count(user))
423 time_t now = ServerInstance->Time();
424 /* +g and *not* accepted */
425 user->WriteNumeric(ERR_TARGUMODEG, dest->nick, "is in +g mode (server-side ignore).");
426 if (now > (dat->lastnotify + (time_t)notify_cooldown))
428 user->WriteNumeric(RPL_TARGNOTIFY, dest->nick, "has been informed that you messaged them.");
429 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 user mode +g set. Use /ACCEPT +%s to allow.",
430 user->nick.c_str()));
431 dat->lastnotify = now;
435 return MOD_RES_PASSTHRU;
438 ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
440 return HandleMessage(user, target);
443 ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
445 return HandleMessage(user, target);
448 void OnUserPostNick(User* user, const std::string& oldnick) CXX11_OVERRIDE
451 RemoveFromAllAccepts(user);
454 void OnUserQuit(User* user, const std::string& message, const std::string& oper_message) CXX11_OVERRIDE
456 RemoveFromAllAccepts(user);
459 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
461 ConfigTag* tag = ServerInstance->Config->ConfValue("callerid");
462 cmd.maxaccepts = tag->getUInt("maxaccepts", 30);
463 tracknick = tag->getBool("tracknick");
464 notify_cooldown = tag->getDuration("cooldown", 60);
467 void Prioritize() CXX11_OVERRIDE
469 // Want to be after modules like silence or services_account
470 ServerInstance->Modules->SetPriority(this, I_OnUserPreMessage, PRIORITY_LAST);
474 MODULE_INIT(ModuleCallerID)