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;
48 // deque list of pairs
49 typedef std::deque<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 User* target = ServerInstance->FindNick(parameters[0]);
98 return ROUTE_OPT_UCAST(target->server);
99 return ROUTE_LOCALONLY;
103 class CommandSilence : public Command
105 unsigned int& maxsilence;
107 SimpleExtItem<silencelist> ext;
108 CommandSilence(Module* Creator, unsigned int &max) : Command(Creator, "SILENCE", 0),
109 maxsilence(max), ext("silence_list", Creator)
111 allow_empty_last_param = false;
112 syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
115 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
117 if (!parameters.size())
119 // no parameters, show the current silence list.
120 silencelist* sl = ext.get(user);
121 // if the user has a silence list associated with their user record, show it
124 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
126 std::string decomppattern = DecompPattern(c->second);
127 user->WriteNumeric(271, "%s %s %s", user->nick.c_str(),c->first.c_str(), decomppattern.c_str());
130 user->WriteNumeric(272, ":End of Silence List");
134 else if (parameters.size() > 0)
136 // one or more parameters, add or delete entry from the list (only the first parameter is used)
137 std::string mask = parameters[0].substr(1);
138 char action = parameters[0][0];
139 // Default is private and notice so clients do not break
140 int pattern = CompilePattern("pn");
142 // if pattern supplied, use it
143 if (parameters.size() > 1) {
144 pattern = CompilePattern(parameters[1].c_str());
149 user->WriteNotice("Bad SILENCE pattern");
155 // 'SILENCE +' or 'SILENCE -', assume *!*@*
159 ModeParser::CleanMask(mask);
163 std::string decomppattern = DecompPattern(pattern);
164 // fetch their silence list
165 silencelist* sl = ext.get(user);
166 // does it contain any entries and does it exist?
169 for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
171 // search through for the item
172 irc::string listitem = i->first.c_str();
173 if (listitem == mask && i->second == pattern)
176 user->WriteNumeric(950, "%s :Removed %s %s from silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
185 user->WriteNumeric(952, "%s :%s %s does not exist on your silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
187 else if (action == '+')
189 // fetch the user's current silence list
190 silencelist* sl = ext.get(user);
193 sl = new silencelist;
196 if (sl->size() > maxsilence)
198 user->WriteNumeric(952, "%s :Your silence list is full",user->nick.c_str());
202 std::string decomppattern = DecompPattern(pattern);
203 for (silencelist::iterator n = sl->begin(); n != sl->end(); n++)
205 irc::string listitem = n->first.c_str();
206 if (listitem == mask && n->second == pattern)
208 user->WriteNumeric(952, "%s :%s %s is already on your silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
212 if (((pattern & SILENCE_EXCLUDE) > 0))
214 sl->push_front(silenceset(mask,pattern));
218 sl->push_back(silenceset(mask,pattern));
220 user->WriteNumeric(951, "%s :Added %s %s to silence list", user->nick.c_str(), mask.c_str(), decomppattern.c_str());
227 /* turn the nice human readable pattern into a mask */
228 int CompilePattern(const char* pattern)
231 for (const char* n = pattern; *n; n++)
236 p |= SILENCE_PRIVATE;
239 p |= SILENCE_CHANNEL;
248 p |= SILENCE_CNOTICE;
255 p |= SILENCE_EXCLUDE;
264 /* turn the mask into a nice human readable format */
265 std::string DecompPattern (const int pattern)
268 if (pattern & SILENCE_PRIVATE)
269 out += ",privatemessages";
270 if (pattern & SILENCE_CHANNEL)
271 out += ",channelmessages";
272 if (pattern & SILENCE_INVITE)
274 if (pattern & SILENCE_NOTICE)
275 out += ",privatenotices";
276 if (pattern & SILENCE_CNOTICE)
277 out += ",channelnotices";
278 if (pattern & SILENCE_ALL)
280 if (pattern & SILENCE_EXCLUDE)
283 return "<" + out.substr(1) + ">";
290 class ModuleSilence : public Module
292 unsigned int maxsilence;
293 CommandSilence cmdsilence;
294 CommandSVSSilence cmdsvssilence;
298 : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
302 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
304 maxsilence = ServerInstance->Config->ConfValue("silence")->getInt("maxentries", 32);
309 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
312 tokens["SILENCE"] = ConvToStr(maxsilence);
315 void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
317 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
318 const UserMembList *ulist = chan->GetUsers();
320 for (UserMembCIter i = ulist->begin(); i != ulist->end(); i++)
322 if (IS_LOCAL(i->first))
324 if (MatchPattern(i->first, sender, public_silence) == MOD_RES_DENY)
326 exempt_list.insert(i->first);
332 ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
334 if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
336 return MatchPattern((User*)dest, user, ((msgtype == MSG_PRIVMSG) ? SILENCE_PRIVATE : SILENCE_NOTICE));
338 else if (target_type == TYPE_CHANNEL)
340 Channel* chan = (Channel*)dest;
341 this->OnBuildExemptList(msgtype, chan, user, status, exempt_list, "");
343 return MOD_RES_PASSTHRU;
346 ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout) CXX11_OVERRIDE
348 return MatchPattern(dest, source, SILENCE_INVITE);
351 ModResult MatchPattern(User* dest, User* source, int pattern)
353 silencelist* sl = cmdsilence.ext.get(dest);
356 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
358 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
359 return (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
362 return MOD_RES_PASSTHRU;
365 Version GetVersion() CXX11_OVERRIDE
367 return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
371 MODULE_INIT(ModuleSilence)