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