2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
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/>.
26 /* $ModDesc: Provides the /SHUN command, which stops a user from executing all except configured commands. */
28 class Shun : public XLine
31 std::string matchtext;
33 Shun(time_t s_time, long d, std::string src, std::string re, std::string shunmask)
34 : XLine(s_time, d, src, re, "SHUN")
36 this->matchtext = shunmask;
49 if (InspIRCd::Match(u->GetFullHost(), matchtext) || InspIRCd::Match(u->GetFullRealHost(), matchtext) || InspIRCd::Match(u->nick+"!"+u->ident+"@"+u->GetIPString(), matchtext))
55 bool Matches(const std::string &s)
64 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired shun %s (set by %s %ld seconds ago)",
65 this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
68 const char* Displayable()
70 return matchtext.c_str();
74 /** An XLineFactory specialized to generate shun pointers
76 class ShunFactory : public XLineFactory
79 ShunFactory() : XLineFactory("SHUN") { }
83 XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
85 return new Shun(set_time, duration, source, reason, xline_specific_mask);
88 bool AutoApplyToUserList(XLine *x)
94 //typedef std::vector<Shun> shunlist;
96 class CommandShun : public Command
99 CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
101 flags_needed = 'o'; this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
104 CmdResult Handle(const std::vector<std::string>& parameters, User *user)
106 /* syntax: SHUN nick!user@host time :reason goes here */
107 /* 'time' is a human-readable timestring, like 2d3h2s. */
109 std::string target = parameters[0];
111 User *find = ServerInstance->FindNick(target.c_str());
113 target = std::string("*!*@") + find->GetIPString();
115 if (parameters.size() == 1)
117 if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", user))
119 ServerInstance->SNO->WriteToSnoMask('x',"%s removed SHUN on %s",user->nick.c_str(),target.c_str());
123 user->WriteServ("NOTICE %s :*** Shun %s not found in list, try /stats H.",user->nick.c_str(),target.c_str());
129 // Adding - XXX todo make this respect <insane> tag perhaps..
132 if (parameters.size() > 2)
134 duration = ServerInstance->Duration(parameters[1]);
135 expr = parameters[2];
140 expr = parameters[1];
143 Shun* r = new Shun(ServerInstance->Time(), duration, user->nick.c_str(), expr.c_str(), target.c_str());
144 if (ServerInstance->XLines->AddLine(r, user))
148 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent SHUN for %s: %s",
149 user->nick.c_str(), target.c_str(), expr.c_str());
153 time_t c_requires_crap = duration + ServerInstance->Time();
154 std::string timestr = ServerInstance->TimeString(c_requires_crap);
155 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s to expire on %s: %s",
156 user->nick.c_str(), target.c_str(), timestr.c_str(), expr.c_str());
162 user->WriteServ("NOTICE %s :*** Shun for %s already exists", user->nick.c_str(), target.c_str());
169 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
171 return ROUTE_BROADCAST;
175 class ModuleShun : public Module
179 std::set<std::string> ShunEnabledCommands;
184 ModuleShun() : cmd(this)
186 ServerInstance->XLines->RegisterFactory(&f);
187 ServerInstance->AddCommand(&cmd);
189 Implementation eventlist[] = { I_OnStats, I_OnPreCommand, I_OnRehash };
190 ServerInstance->Modules->Attach(eventlist, this, 3);
194 virtual ~ModuleShun()
196 ServerInstance->XLines->DelAll("SHUN");
197 ServerInstance->XLines->UnregisterFactory(&f);
202 Module* alias = ServerInstance->Modules->Find("m_alias.so");
203 ServerInstance->Modules->SetPriority(this, I_OnPreCommand, PRIORITY_BEFORE, &alias);
206 virtual ModResult OnStats(char symbol, User* user, string_list& out)
209 return MOD_RES_PASSTHRU;
211 ServerInstance->XLines->InvokeStats("SHUN", 223, user, out);
215 virtual void OnRehash(User* user)
218 std::string cmds = MyConf.ReadValue("shun", "enabledcommands", 0);
219 std::transform(cmds.begin(), cmds.end(), cmds.begin(), ::toupper);
222 cmds = "PING PONG QUIT";
224 ShunEnabledCommands.clear();
226 std::stringstream dcmds(cmds);
229 while (dcmds >> thiscmd)
231 ShunEnabledCommands.insert(thiscmd);
234 NotifyOfShun = MyConf.ReadFlag("shun", "notifyuser", "yes", 0);
235 affectopers = MyConf.ReadFlag("shun", "affectopers", "no", 0);
238 virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser* user, bool validated, const std::string &original_line)
241 return MOD_RES_PASSTHRU;
243 if (!ServerInstance->XLines->MatchesLine("SHUN", user))
245 /* Not shunned, don't touch. */
246 return MOD_RES_PASSTHRU;
249 if (!affectopers && IS_OPER(user))
251 /* Don't do anything if the user is an operator and affectopers isn't set */
252 return MOD_RES_PASSTHRU;
255 std::set<std::string>::iterator i = ShunEnabledCommands.find(command);
257 if (i == ShunEnabledCommands.end())
260 user->WriteServ("NOTICE %s :*** Command %s not processed, as you have been blocked from issuing commands (SHUN)", user->nick.c_str(), command.c_str());
264 if (command == "QUIT")
266 /* Allow QUIT but dont show any quit message */
269 else if ((command == "PART") && (parameters.size() > 1))
272 parameters[1].clear();
275 /* if we're here, allow the command. */
276 return MOD_RES_PASSTHRU;
279 virtual Version GetVersion()
281 return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
285 MODULE_INIT(ModuleShun)