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