1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2010 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
16 /* $ModDesc: Provides support for the /SILENCE command */
18 /* Improved drop-in replacement for the /SILENCE command
19 * syntax: /SILENCE [+|-]<mask> <p|c|i|n|t|a|x> as in <privatemessage|channelmessage|invites|privatenotice|channelnotice|all|exclude>
21 * example that blocks all except private messages
25 * example that blocks all invites except from channel services
27 * /SILENCE +chanserv!services@chatters.net ix
29 * example that blocks some bad dude from private, notice and inviting you
30 * /SILENCE +*!kiddie@lamerz.net pin
32 * TODO: possibly have add and remove check for existing host and only modify flags according to
33 * what's been changed instead of having to remove first, then add if you want to change
37 // pair of hostmask and flags
38 typedef std::pair<std::string, int> silenceset;
40 // deque list of pairs
41 typedef std::deque<silenceset> silencelist;
44 static int SILENCE_PRIVATE = 0x0001; /* p private messages */
45 static int SILENCE_CHANNEL = 0x0002; /* c channel messages */
46 static int SILENCE_INVITE = 0x0004; /* i invites */
47 static int SILENCE_NOTICE = 0x0008; /* n notices */
48 static int SILENCE_CNOTICE = 0x0010; /* t channel notices */
49 static int SILENCE_ALL = 0x0020; /* a all, (pcint) */
50 static int SILENCE_EXCLUDE = 0x0040; /* x exclude this pattern */
53 class CommandSVSSilence : public Command
56 CommandSVSSilence(Module* Creator) : Command(Creator,"SVSSILENCE", 2)
58 syntax = "<target> {[+|-]<mask> <p|c|i|n|t|a|x>}";
59 TRANSLATE4(TR_NICK, TR_TEXT, TR_TEXT, TR_END); /* we watch for a nick. not a UID. */
62 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
65 * XXX: thought occurs to me
66 * We may want to change the syntax of this command to
67 * SVSSILENCE <flagsora+> +<nick> -<nick> +<nick>
68 * style command so services can modify lots of entries at once.
69 * leaving it backwards compatible for now as it's late. -- w
71 if (!ServerInstance->ULine(user->server))
74 User *u = ServerInstance->FindNick(parameters[0]);
80 ServerInstance->Parser->CallHandler("SILENCE", std::vector<std::string>(++parameters.begin(), parameters.end()), u);
86 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
88 User* target = ServerInstance->FindNick(parameters[0]);
90 return ROUTE_OPT_UCAST(target->server);
91 return ROUTE_LOCALONLY;
95 class CommandSilence : public Command
97 unsigned int& maxsilence;
99 SimpleExtItem<silencelist> ext;
100 CommandSilence(Module* Creator, unsigned int &max) : Command(Creator, "SILENCE", 0),
101 maxsilence(max), ext("silence_list", Creator)
103 syntax = "{[+|-]<mask> <p|c|i|n|t|a|x>}";
104 TRANSLATE3(TR_TEXT, TR_TEXT, TR_END);
107 CmdResult Handle (const std::vector<std::string>& parameters, User *user)
109 if (!parameters.size())
111 // no parameters, show the current silence list.
112 silencelist* sl = ext.get(user);
113 // if the user has a silence list associated with their user record, show it
116 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
118 user->WriteNumeric(271, "%s %s %s %s",user->nick.c_str(), user->nick.c_str(),c->first.c_str(), DecompPattern(c->second).c_str());
121 user->WriteNumeric(272, "%s :End of Silence List",user->nick.c_str());
125 else if (parameters.size() > 0)
127 // one or more parameters, add or delete entry from the list (only the first parameter is used)
128 std::string mask = parameters[0].substr(1);
129 char action = parameters[0][0];
130 // Default is private and notice so clients do not break
131 int pattern = CompilePattern("pn");
133 // if pattern supplied, use it
134 if (parameters.size() > 1) {
135 pattern = CompilePattern(parameters[1].c_str());
140 user->WriteServ("NOTICE %s :Bad SILENCE pattern",user->nick.c_str());
146 // 'SILENCE +' or 'SILENCE -', assume *!*@*
150 ModeParser::CleanMask(mask);
154 // fetch their silence list
155 silencelist* sl = ext.get(user);
156 // does it contain any entries and does it exist?
159 for (silencelist::iterator i = sl->begin(); i != sl->end(); i++)
161 // search through for the item
162 irc::string listitem = i->first.c_str();
163 if (listitem == mask && i->second == pattern)
166 user->WriteNumeric(950, "%s %s :Removed %s %s from silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
175 user->WriteNumeric(952, "%s %s :%s %s does not exist on your silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
177 else if (action == '+')
179 // fetch the user's current silence list
180 silencelist* sl = ext.get(user);
183 sl = new silencelist;
186 if (sl->size() > maxsilence)
188 user->WriteNumeric(952, "%s %s :Your silence list is full",user->nick.c_str(), user->nick.c_str());
191 for (silencelist::iterator n = sl->begin(); n != sl->end(); n++)
193 irc::string listitem = n->first.c_str();
194 if (listitem == mask && n->second == pattern)
196 user->WriteNumeric(952, "%s %s :%s %s is already on your silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
200 if (((pattern & SILENCE_EXCLUDE) > 0))
202 sl->push_front(silenceset(mask,pattern));
206 sl->push_back(silenceset(mask,pattern));
208 user->WriteNumeric(951, "%s %s :Added %s %s to silence list",user->nick.c_str(), user->nick.c_str(), mask.c_str(), DecompPattern(pattern).c_str());
215 /* turn the nice human readable pattern into a mask */
216 int CompilePattern(const char* pattern)
219 for (const char* n = pattern; *n; n++)
224 p |= SILENCE_PRIVATE;
227 p |= SILENCE_CHANNEL;
236 p |= SILENCE_CNOTICE;
243 p |= SILENCE_EXCLUDE;
252 /* turn the mask into a nice human readable format */
253 std::string DecompPattern (const int pattern)
256 if (pattern & SILENCE_PRIVATE)
257 out += ",privatemessages";
258 if (pattern & SILENCE_CHANNEL)
259 out += ",channelmessages";
260 if (pattern & SILENCE_INVITE)
262 if (pattern & SILENCE_NOTICE)
263 out += ",privatenotices";
264 if (pattern & SILENCE_CNOTICE)
265 out += ",channelnotices";
266 if (pattern & SILENCE_ALL)
268 if (pattern & SILENCE_EXCLUDE)
271 return "<" + out.substr(1) + ">";
278 class ModuleSilence : public Module
280 unsigned int maxsilence;
281 CommandSilence cmdsilence;
282 CommandSVSSilence cmdsvssilence;
286 : maxsilence(32), cmdsilence(this, maxsilence), cmdsvssilence(this)
289 ServerInstance->AddCommand(&cmdsilence);
290 ServerInstance->AddCommand(&cmdsvssilence);
292 Implementation eventlist[] = { I_OnRehash, I_On005Numeric, I_OnUserPreNotice, I_OnUserPreMessage, I_OnUserPreInvite };
293 ServerInstance->Modules->Attach(eventlist, this, 5);
296 void OnRehash(User* user)
299 maxsilence = Conf.ReadInteger("silence", "maxentries", 0, true);
304 void On005Numeric(std::string &output)
306 // we don't really have a limit...
307 output = output + " ESILENCE SILENCE=" + ConvToStr(maxsilence);
310 void OnBuildExemptList(MessageType message_type, Channel* chan, User* sender, char status, CUList &exempt_list, const std::string &text)
312 int public_silence = (message_type == MSG_PRIVMSG ? SILENCE_CHANNEL : SILENCE_CNOTICE);
313 const UserMembList *ulist = chan->GetUsers();
315 for (UserMembCIter i = ulist->begin(); i != ulist->end(); i++)
317 if (IS_LOCAL(i->first))
319 if (MatchPattern(i->first, sender, public_silence) == MOD_RES_ALLOW)
321 exempt_list.insert(i->first);
327 ModResult PreText(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list, int silence_type)
329 if (target_type == TYPE_USER && IS_LOCAL(((User*)dest)))
331 return MatchPattern((User*)dest, user, silence_type);
333 else if (target_type == TYPE_CHANNEL)
335 Channel* chan = (Channel*)dest;
338 this->OnBuildExemptList((silence_type == SILENCE_PRIVATE ? MSG_PRIVMSG : MSG_NOTICE), chan, user, status, exempt_list, "");
341 return MOD_RES_PASSTHRU;
344 ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
346 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_PRIVATE);
349 ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
351 return PreText(user, dest, target_type, text, status, exempt_list, SILENCE_NOTICE);
354 ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout)
356 return MatchPattern(dest, source, SILENCE_INVITE);
359 ModResult MatchPattern(User* dest, User* source, int pattern)
362 if (!source || !dest)
363 return MOD_RES_ALLOW;
365 silencelist* sl = cmdsilence.ext.get(dest);
368 for (silencelist::const_iterator c = sl->begin(); c != sl->end(); c++)
370 if (((((c->second & pattern) > 0)) || ((c->second & SILENCE_ALL) > 0)) && (InspIRCd::Match(source->GetFullHost(), c->first)))
371 return (c->second & SILENCE_EXCLUDE) ? MOD_RES_PASSTHRU : MOD_RES_DENY;
374 return MOD_RES_PASSTHRU;
383 return Version("Provides support for the /SILENCE command", VF_OPTCOMMON | VF_VENDOR);
387 MODULE_INIT(ModuleSilence)