2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
6 * Copyright (C) 2017-2018 B00mX0r <b00mx0r@aureus.pw>
7 * Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
8 * Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
9 * Copyright (C) 2012, 2018-2019 Robby <robby@chatbelgie.be>
10 * Copyright (C) 2012 Jens Voss <DukePyrolator@anope.org>
11 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
12 * Copyright (C) 2009 Matt Smith <dz@inspircd.org>
13 * Copyright (C) 2009 John Brooks <special@inspircd.org>
14 * Copyright (C) 2009 Dennis Friis <peavey@inspircd.org>
15 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
16 * Copyright (C) 2008-2010 Craig Edwards <brain@inspircd.org>
17 * Copyright (C) 2008-2009 Robin Burchell <robin+git@viroteck.net>
18 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
20 * This file is part of InspIRCd. InspIRCd is free software: you can
21 * redistribute it and/or modify it under the terms of the GNU General Public
22 * License as published by the Free Software Foundation, version 2.
24 * This program is distributed in the hope that it will be useful, but WITHOUT
25 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
26 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 #include "modules/shun.h"
37 #include "modules/stats.h"
40 /** An XLineFactory specialized to generate shun pointers
42 class ShunFactory : public XLineFactory
45 ShunFactory() : XLineFactory("SHUN") { }
49 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
51 return new Shun(set_time, duration, source, reason, xline_specific_mask);
54 bool AutoApplyToUserList(XLine* x) CXX11_OVERRIDE
60 //typedef std::vector<Shun> shunlist;
62 class CommandShun : public Command
65 CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
67 flags_needed = 'o'; this->syntax = "<nick!user@host> [<duration> :<reason>]";
70 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
72 /* syntax: SHUN nick!user@host time :reason goes here */
73 /* 'time' is a human-readable timestring, like 2d3h2s. */
75 std::string target = parameters[0];
77 User *find = ServerInstance->FindNick(target);
78 if ((find) && (find->registered == REG_ALL))
79 target = std::string("*!*@") + find->GetIPString();
81 if (parameters.size() == 1)
85 if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SHUN", reason, user))
87 ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s: %s", user->nick.c_str(), parameters[0].c_str(), reason.c_str());
89 else if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", reason, user))
91 ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s: %s", user->nick.c_str(), target.c_str(), reason.c_str());
95 user->WriteNotice("*** Shun " + parameters[0] + " not found on the list.");
101 // Adding - XXX todo make this respect <insane> tag perhaps..
102 unsigned long duration;
104 if (parameters.size() > 2)
106 if (!InspIRCd::Duration(parameters[1], duration))
108 user->WriteNotice("*** Invalid duration for SHUN.");
111 expr = parameters[2];
116 expr = parameters[1];
119 Shun* r = new Shun(ServerInstance->Time(), duration, user->nick.c_str(), expr.c_str(), target.c_str());
120 if (ServerInstance->XLines->AddLine(r, user))
124 ServerInstance->SNO->WriteToSnoMask('x', "%s added permanent SHUN for %s: %s",
125 user->nick.c_str(), target.c_str(), expr.c_str());
129 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s, expires in %s (on %s): %s",
130 user->nick.c_str(), target.c_str(), InspIRCd::DurationString(duration).c_str(),
131 InspIRCd::TimeString(ServerInstance->Time() + duration).c_str(), expr.c_str());
137 user->WriteNotice("*** Shun for " + target + " already exists.");
144 RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
147 return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
149 return ROUTE_BROADCAST;
153 class ModuleShun : public Module, public Stats::EventListener
157 insp::flat_set<std::string> ShunEnabledCommands;
161 bool IsShunned(LocalUser* user)
163 // Exempt the user from shuns if they are an oper and affectopers is disabled.
164 if (!affectopers && user->IsOper())
167 // Exempt the user from shuns if they are an oper with the servers/ignore-shun privilege.
168 if (user->HasPrivPermission("servers/ignore-shun"))
171 // Check whether the user is actually shunned.
172 return ServerInstance->XLines->MatchesLine("SHUN", user);
177 : Stats::EventListener(this)
182 void init() CXX11_OVERRIDE
184 ServerInstance->XLines->RegisterFactory(&f);
189 ServerInstance->XLines->DelAll("SHUN");
190 ServerInstance->XLines->UnregisterFactory(&f);
193 void Prioritize() CXX11_OVERRIDE
195 Module* alias = ServerInstance->Modules->Find("m_alias.so");
196 ServerInstance->Modules->SetPriority(this, I_OnPreCommand, PRIORITY_BEFORE, alias);
199 ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
201 if (stats.GetSymbol() != 'H')
202 return MOD_RES_PASSTHRU;
204 ServerInstance->XLines->InvokeStats("SHUN", stats);
208 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
210 ConfigTag* tag = ServerInstance->Config->ConfValue("shun");
212 ShunEnabledCommands.clear();
213 irc::spacesepstream enabledcmds(tag->getString("enabledcommands", "ADMIN OPER PING PONG QUIT", 1));
214 for (std::string enabledcmd; enabledcmds.GetToken(enabledcmd); )
216 std::transform(enabledcmd.begin(), enabledcmd.end(), enabledcmd.begin(), ::toupper);
217 ShunEnabledCommands.insert(enabledcmd);
220 NotifyOfShun = tag->getBool("notifyuser", true);
221 affectopers = tag->getBool("affectopers", false);
224 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
226 if (validated || !IsShunned(user))
227 return MOD_RES_PASSTHRU;
229 if (!ShunEnabledCommands.count(command))
232 user->WriteNotice("*** Command " + command + " not processed, as you have been blocked from issuing commands (SHUN)");
236 if (command == "QUIT")
238 /* Allow QUIT but dont show any quit message */
241 else if ((command == "PART") && (parameters.size() > 1))
244 parameters.pop_back();
247 /* if we're here, allow the command. */
248 return MOD_RES_PASSTHRU;
251 Version GetVersion() CXX11_OVERRIDE
253 return Version("Adds the /SHUN command which allows server operators to prevent users from executing commands.", VF_VENDOR|VF_COMMON);
257 MODULE_INIT(ModuleShun)