src/modules/m_shun.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   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>
   8  *
   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.
  12  *
  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
  16  * details.
  17  *
  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/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24 #include "xline.h"
  25 #include "modules/shun.h"
  26 #include "modules/stats.h"
  27
  28
  29 /** An XLineFactory specialized to generate shun pointers
  30  */
  31 class ShunFactory : public XLineFactory
  32 {
  33  public:
  34         ShunFactory() : XLineFactory("SHUN") { }
  35
  36         /** Generate a shun
  37         */
  38         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
  39         {
  40                 return new Shun(set_time, duration, source, reason, xline_specific_mask);
  41         }
  42
  43         bool AutoApplyToUserList(XLine* x) CXX11_OVERRIDE
  44         {
  45                 return false;
  46         }
  47 };
  48
  49 //typedef std::vector<Shun> shunlist;
  50
  51 class CommandShun : public Command
  52 {
  53  public:
  54         CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
  55         {
  56                 flags_needed = 'o'; this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
  57         }
  58
  59         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
  60         {
  61                 /* syntax: SHUN nick!user@host time :reason goes here */
  62                 /* 'time' is a human-readable timestring, like 2d3h2s. */
  63
  64                 std::string target = parameters[0];
  65
  66                 User *find = ServerInstance->FindNick(target);
  67                 if ((find) && (find->registered == REG_ALL))
  68                         target = std::string("*!*@") + find->GetIPString();
  69
  70                 if (parameters.size() == 1)
  71                 {
  72                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SHUN", user))
  73                         {
  74                                 ServerInstance->SNO->WriteToSnoMask('x', "%s removed SHUN on %s", user->nick.c_str(), parameters[0].c_str());
  75                         }
  76                         else if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", user))
  77                         {
  78                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed SHUN on %s", user->nick.c_str(), target.c_str());
  79                         }
  80                         else
  81                         {
  82                                 user->WriteNotice("*** Shun " + parameters[0] + " not found in list, try /stats H.");
  83                                 return CMD_FAILURE;
  84                         }
  85                 }
  86                 else
  87                 {
  88                         // Adding - XXX todo make this respect <insane> tag perhaps..
  89                         unsigned long duration;
  90                         std::string expr;
  91                         if (parameters.size() > 2)
  92                         {
  93                                 if (!InspIRCd::Duration(parameters[1], duration))
  94                                 {
  95                                         user->WriteNotice("*** Invalid duration for SHUN");
  96                                         return CMD_FAILURE;
  97                                 }
  98                                 expr = parameters[2];
  99                         }
 100                         else
 101                         {
 102                                 duration = 0;
 103                                 expr = parameters[1];
 104                         }
 105
 106                         Shun* r = new Shun(ServerInstance->Time(), duration, user->nick.c_str(), expr.c_str(), target.c_str());
 107                         if (ServerInstance->XLines->AddLine(r, user))
 108                         {
 109                                 if (!duration)
 110                                 {
 111                                         ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent SHUN for %s: %s",
 112                                                 user->nick.c_str(), target.c_str(), expr.c_str());
 113                                 }
 114                                 else
 115                                 {
 116                                         time_t c_requires_crap = duration + ServerInstance->Time();
 117                                         std::string timestr = InspIRCd::TimeString(c_requires_crap);
 118                                         ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s to expire on %s: %s",
 119                                                 user->nick.c_str(), target.c_str(), timestr.c_str(), expr.c_str());
 120                                 }
 121                         }
 122                         else
 123                         {
 124                                 delete r;
 125                                 user->WriteNotice("*** Shun for " + target + " already exists");
 126                                 return CMD_FAILURE;
 127                         }
 128                 }
 129                 return CMD_SUCCESS;
 130         }
 131
 132         RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
 133         {
 134                 if (IS_LOCAL(user))
 135                         return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
 136
 137                 return ROUTE_BROADCAST;
 138         }
 139 };
 140
 141 class ModuleShun : public Module, public Stats::EventListener
 142 {
 143         CommandShun cmd;
 144         ShunFactory f;
 145         insp::flat_set<std::string> ShunEnabledCommands;
 146         bool NotifyOfShun;
 147         bool affectopers;
 148
 149  public:
 150         ModuleShun()
 151                 : Stats::EventListener(this)
 152                 , cmd(this)
 153         {
 154         }
 155
 156         void init() CXX11_OVERRIDE
 157         {
 158                 ServerInstance->XLines->RegisterFactory(&f);
 159         }
 160
 161         ~ModuleShun()
 162         {
 163                 ServerInstance->XLines->DelAll("SHUN");
 164                 ServerInstance->XLines->UnregisterFactory(&f);
 165         }
 166
 167         void Prioritize() CXX11_OVERRIDE
 168         {
 169                 Module* alias = ServerInstance->Modules->Find("m_alias.so");
 170                 ServerInstance->Modules->SetPriority(this, I_OnPreCommand, PRIORITY_BEFORE, alias);
 171         }
 172
 173         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
 174         {
 175                 if (stats.GetSymbol() != 'H')
 176                         return MOD_RES_PASSTHRU;
 177
 178                 ServerInstance->XLines->InvokeStats("SHUN", 223, stats);
 179                 return MOD_RES_DENY;
 180         }
 181
 182         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 183         {
 184                 ConfigTag* tag = ServerInstance->Config->ConfValue("shun");
 185                 std::string cmds = tag->getString("enabledcommands");
 186                 std::transform(cmds.begin(), cmds.end(), cmds.begin(), ::toupper);
 187
 188                 if (cmds.empty())
 189                         cmds = "PING PONG QUIT";
 190
 191                 ShunEnabledCommands.clear();
 192
 193                 irc::spacesepstream dcmds(cmds);
 194                 std::string thiscmd;
 195
 196                 while (dcmds.GetToken(thiscmd))
 197                 {
 198                         ShunEnabledCommands.insert(thiscmd);
 199                 }
 200
 201                 NotifyOfShun = tag->getBool("notifyuser", true);
 202                 affectopers = tag->getBool("affectopers", false);
 203         }
 204
 205         ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
 206         {
 207                 if (validated)
 208                         return MOD_RES_PASSTHRU;
 209
 210                 if (!ServerInstance->XLines->MatchesLine("SHUN", user))
 211                 {
 212                         /* Not shunned, don't touch. */
 213                         return MOD_RES_PASSTHRU;
 214                 }
 215
 216                 if (!affectopers && user->IsOper())
 217                 {
 218                         /* Don't do anything if the user is an operator and affectopers isn't set */
 219                         return MOD_RES_PASSTHRU;
 220                 }
 221
 222                 if (!ShunEnabledCommands.count(command))
 223                 {
 224                         if (NotifyOfShun)
 225                                 user->WriteNotice("*** Command " + command + " not processed, as you have been blocked from issuing commands (SHUN)");
 226                         return MOD_RES_DENY;
 227                 }
 228
 229                 if (command == "QUIT")
 230                 {
 231                         /* Allow QUIT but dont show any quit message */
 232                         parameters.clear();
 233                 }
 234                 else if ((command == "PART") && (parameters.size() > 1))
 235                 {
 236                         /* same for PART */
 237                         parameters.pop_back();
 238                 }
 239
 240                 /* if we're here, allow the command. */
 241                 return MOD_RES_PASSTHRU;
 242         }
 243
 244         Version GetVersion() CXX11_OVERRIDE
 245         {
 246                 return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
 247         }
 248 };
 249
 250 MODULE_INIT(ModuleShun)