2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2005-2007 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2006 John Brooks <john.brooks@dereferenced.net>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 /* Improved drop-in replacement for the /SILENCE command
27 * syntax: /SILENCE [+|-]<mask> <p|c|i|n|t|a|x> as in <privatemessage|channelmessage|invites|privatenotice|channelnotice|all|exclude>
29 * example that blocks all except private messages
33 * example that blocks all invites except from channel services
35 * /SILENCE +chanserv!services@chatters.net ix
37 * example that blocks some bad dude from private, notice and inviting you
38 * /SILENCE +*!kiddie@lamerz.net pin
40 * TODO: possibly have add and remove check for existing host and only modify flags according to
41 * what's been changed instead of having to remove first, then add if you want to change
45 // pair of hostmask and flags
46 typedef std::pair<std::string, int> silenceset;
49 typedef std::vector<silenceset> silencelist;
52 static int SILENCE_PRIVATE = 0x0001; /* p private messages */
53 static int SILENCE_CHANNEL = 0x0002; /* c channel messages */
54 static int SILENCE_INVITE = 0x0004; /* i invites */
55 static int SILENCE_NOTICE = 0x0008; /* n notices */
56 static int SILENCE_CNOTICE = 0x0010; /* t channel notices */
57 static int SILENCE_ALL = 0x0020; /* a all, (pcint) */
58 static int SILENCE_EXCLUDE = 0x0040; /* x exclude this pattern */
61 class CommandSVSSilence : public Command
64 CommandSVSSilence(Module* Creator) : Command(Creator,"SVSSILENCE", 2)
66 syntax = "<target> {[+|-]<mask> <p|c|i|n|t|a|x>}";
67 TRANSLATE3(TR_NICK, TR_TEXT, TR_TEXT);
70 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
73 * XXX: thought occurs to me
74 * We may want to change the syntax of this command to
75 * SVSSILENCE <flagsora+> +<nick> -<nick> +<nick>
76 * style command so services can modify lots of entries at once.
77 * leaving it backwards compatible for now as it's late. -- w
79 if (!user->server->IsULine())
82 User *u = ServerInstance->FindNick(parameters[0]);
88 ServerInstance->Parser.CallHandler("SILENCE", std::vector<std::string>(parameters.begin() + 1, parameters.end()), u);
94 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
96 return ROUTE_OPT_UCAST(parameters[0]);
100 class CommandSilence : public Command
102 unsigned int& maxsilence;
104 SimpleExtItem<silencelist> ext;
105 CommandSilence(Module* Creator, unsigned int &max) : Command(Creator, "SILENCE", 0),
107 , ext("silence_list", ExtensionItem::EXT_USER, Creator)
109 allow_empty_last_param = false;
110 syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
113 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
115 if (!parameters.size())
117 // no parameters, show the current silence list.
118 silencelist* sl = ext.get(user);
119 // if the user has a silence list associated with their user record, show it
122 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
124 std::string decomppattern = DecompPattern(c->second);
125 user->WriteNumeric(271, user->nick, c->first, decomppattern);
128 user->WriteNumeric(272, "End of Silence List");
132 else if (parameters.size() > 0)
134 // one or more parameters, add or delete entry from the list (only the first parameter is used)
135 std::string mask(parameters[0], 1);
136 char action = parameters[0][0];
137 // Default is private and notice so clients do not break
138 int pattern = CompilePattern("pn");
140 // if pattern supplied, use it
141 if (parameters.size() > 1) {
142 pattern = CompilePattern(parameters[1].c_str());
147 user->WriteNotice("Bad SILENCE pattern");
153 // 'SILENCE +' or 'SILENCE -', assume *!*@*
157 ModeParser::CleanMask(mask);
161 std::string decomppattern = DecompPattern(pattern);
162 // fetch their silence list
163 silencelist* sl = ext.get(user);
164 // does it contain any entries and does it exist?
167 for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
169 // search through for the item
170 irc::string listitem = i->first.c_str();
171 if (listitem == mask && i->second == pattern)
174 user->WriteNumeric(950, user->nick, InspIRCd::Format("Removed %s %s from silence list", mask.c_str(), decomppattern.c_str()));
183 user->WriteNumeric(952, user->nick, InspIRCd::Format("%s %s does not exist on your silence list", mask.c_str(), decomppattern.c_str()));
185 else if (action == '+')
187 // fetch the user's current silence list
188 silencelist* sl = ext.get(user);
191 sl = new silencelist;
194 if (sl->size() > maxsilence)
196 user->WriteNumeric(952, user->nick, "Your silence list is full");
200 std::string decomppattern = DecompPattern(pattern);
201 for (silencelist::iterator n = sl->begin(); n != sl->end(); n++)
203 irc::string listitem = n->first.c_str();
204 if (listitem == mask && n->second == pattern)
206 user->WriteNumeric(952, user->nick, InspIRCd::Format("%s %s is already on your silence list", mask.c_str(), decomppattern.c_str()));
210 if (((pattern & SILENCE_EXCLUDE) > 0))
212 sl->insert(sl->begin(), silenceset(mask, pattern));
216 sl->push_back(silenceset(mask,pattern));
218 user->WriteNumeric(951, user->nick, InspIRCd::Format("Added %s %s to silence list", mask.c_str(), decomppattern.c_str()));
225 /* turn the nice human readable pattern into a mask */
226 int CompilePattern(const char* pattern)
229 for (const char* n = pattern; *n; n++)
234 p |= SILENCE_PRIVATE;
237 p |= SILENCE_CHANNEL;
246 p |= SILENCE_CNOTICE;
253 p |= SILENCE_EXCLUDE;
262 /* turn the mask into a nice human readable format */
263 std::string DecompPattern (const int pattern)
266 if (pattern & SILENCE_PRIVATE)
267 out += ",privatemessages";
268 if (pattern & SILENCE_CHANNEL)
269 out += ",channelmessages";
270 if (pattern & SILENCE_INVITE)
272 if (pattern & SILENCE_NOTICE)
273 out += ",privatenotices";
274 if (pattern & SILENCE_CNOTICE)
275 out += ",channelnotices";
276 if (pattern & SILENCE_ALL)
278 if (pattern & SILENCE_EXCLUDE)
281 return "<" + out.substr(1) + ">";
288 class ModuleSilence : public Module
290 unsigned int maxsilence;
292 CommandSilence cmdsilence;
293 CommandSVSSilence cmdsvssilence;
297 : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
301 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
303 ConfigTag* tag = ServerInstance->Config->ConfValue("silence");
305 maxsilence = tag->getInt("maxentries", 32);
309 ExemptULine = tag->getBool("exemptuline", true);
312 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
315 tokens["SILENCE"] = ConvToStr(maxsilence);
318 void BuildExemptList(MessageType message_type, Channel* chan, User* sender, CUList& exempt_list)
320 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
322 const Channel::MemberMap& ulist = chan->GetUsers();
323 for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
325 if (IS_LOCAL(i->first))
327 if (MatchPattern(i->first, sender, public_silence) == MOD_RES_DENY)
329 exempt_list.insert(i->first);
335 ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
337 if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
339 return MatchPattern((User*)dest, user, ((msgtype == MSG_PRIVMSG) ? SILENCE_PRIVATE : SILENCE_NOTICE));
341 else if (target_type == TYPE_CHANNEL)
343 Channel* chan = (Channel*)dest;
344 BuildExemptList(msgtype, chan, user, exempt_list);
346 return MOD_RES_PASSTHRU;
349 ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout) CXX11_OVERRIDE
351 return MatchPattern(dest, source, SILENCE_INVITE);
354 ModResult MatchPattern(User* dest, User* source, int pattern)
356 if (ExemptULine && source->server->IsULine())
357 return MOD_RES_PASSTHRU;
359 silencelist* sl = cmdsilence.ext.get(dest);
362 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
364 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
365 return (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
368 return MOD_RES_PASSTHRU;
371 Version GetVersion() CXX11_OVERRIDE
373 return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
377 MODULE_INIT(ModuleSilence)