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 /* $ModDesc: Provides the /SHUN command, which stops a user from executing all except configured commands. */
  27
  28 class Shun : public XLine
  29 {
  30 public:
  31         std::string matchtext;
  32
  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")
  35         {
  36                 this->matchtext = shunmask;
  37         }
  38
  39         ~Shun()
  40         {
  41         }
  42
  43         bool Matches(User *u)
  44         {
  45                 // E: overrides shun
  46                 if (u->exempt)
  47                         return false;
  48
  49                 if (InspIRCd::Match(u->GetFullHost(), matchtext) || InspIRCd::Match(u->GetFullRealHost(), matchtext) || InspIRCd::Match(u->nick+"!"+u->ident+"@"+u->GetIPString(), matchtext))
  50                         return true;
  51
  52                 return false;
  53         }
  54
  55         bool Matches(const std::string &s)
  56         {
  57                 if (matchtext == s)
  58                         return true;
  59                 return false;
  60         }
  61
  62         void Apply(User *u)
  63         {
  64         }
  65
  66
  67         void DisplayExpiry()
  68         {
  69                 ServerInstance->SNO->WriteToSnoMask('x',"Removing expired shun %s (set by %s %ld seconds ago)",
  70                         this->matchtext.c_str(), this->source.c_str(), (long int)(ServerInstance->Time() - this->set_time));
  71         }
  72
  73         const char* Displayable()
  74         {
  75                 return matchtext.c_str();
  76         }
  77 };
  78
  79 /** An XLineFactory specialized to generate shun pointers
  80  */
  81 class ShunFactory : public XLineFactory
  82 {
  83  public:
  84         ShunFactory() : XLineFactory("SHUN") { }
  85
  86         /** Generate a shun
  87         */
  88         XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
  89         {
  90                 return new Shun(set_time, duration, source, reason, xline_specific_mask);
  91         }
  92 };
  93
  94 //typedef std::vector<Shun> shunlist;
  95
  96 class CommandShun : public Command
  97 {
  98  public:
  99         CommandShun(Module* Creator) : Command(Creator, "SHUN", 1, 3)
 100         {
 101                 flags_needed = 'o'; this->syntax = "<nick!user@hostmask> [<shun-duration>] :<reason>";
 102         }
 103
 104         CmdResult Handle(const std::vector<std::string>& parameters, User *user)
 105         {
 106                 /* syntax: SHUN nick!user@host time :reason goes here */
 107                 /* 'time' is a human-readable timestring, like 2d3h2s. */
 108
 109                 std::string target = parameters[0];
 110
 111                 User *find = ServerInstance->FindNick(target.c_str());
 112                 if (find)
 113                         target = std::string("*!*@") + find->GetIPString();
 114
 115                 if (parameters.size() == 1)
 116                 {
 117                         if (ServerInstance->XLines->DelLine(target.c_str(), "SHUN", user))
 118                         {
 119                                 ServerInstance->SNO->WriteToSnoMask('x',"%s removed SHUN on %s",user->nick.c_str(),target.c_str());
 120                         }
 121                         else
 122                         {
 123                                 user->WriteServ("NOTICE %s :*** Shun %s not found in list, try /stats H.",user->nick.c_str(),target.c_str());
 124                         }
 125
 126                         return CMD_SUCCESS;
 127                 }
 128                 else if (parameters.size() >= 2)
 129                 {
 130                         // Adding - XXX todo make this respect <insane> tag perhaps..
 131                         long duration;
 132                         std::string expr;
 133                         if (parameters.size() > 2)
 134                         {
 135                                 duration = ServerInstance->Duration(parameters[1]);
 136                                 expr = parameters[2];
 137                         }
 138                         else
 139                         {
 140                                 duration = 0;
 141                                 expr = parameters[1];
 142                         }
 143                         Shun *r = NULL;
 144
 145                         try
 146                         {
 147                                 r = new Shun(ServerInstance->Time(), duration, user->nick.c_str(), expr.c_str(), target.c_str());
 148                         }
 149                         catch (...)
 150                         {
 151                                 ; // Do nothing. If we get here, the regex was fucked up, and they already got told it fucked up.
 152                         }
 153
 154                         if (r)
 155                         {
 156                                 if (ServerInstance->XLines->AddLine(r, user))
 157                                 {
 158                                         if (!duration)
 159                                         {
 160                                                 ServerInstance->SNO->WriteToSnoMask('x',"%s added permanent SHUN for %s: %s",
 161                                                         user->nick.c_str(), target.c_str(), expr.c_str());
 162                                         }
 163                                         else
 164                                         {
 165                                                 time_t c_requires_crap = duration + ServerInstance->Time();
 166                                                 ServerInstance->SNO->WriteToSnoMask('x', "%s added timed SHUN for %s to expire on %s: %s",
 167                                                         user->nick.c_str(), target.c_str(), ServerInstance->TimeString(c_requires_crap).c_str(), expr.c_str());
 168                                         }
 169
 170                                         ServerInstance->XLines->ApplyLines();
 171                                 }
 172                                 else
 173                                 {
 174                                         delete r;
 175                                         user->WriteServ("NOTICE %s :*** Shun for %s already exists", user->nick.c_str(), expr.c_str());
 176                                 }
 177                         }
 178                 }
 179
 180                 return CMD_FAILURE;
 181         }
 182
 183         RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
 184         {
 185                 return ROUTE_BROADCAST;
 186         }
 187 };
 188
 189 class ModuleShun : public Module
 190 {
 191         CommandShun cmd;
 192         ShunFactory f;
 193         std::set<std::string> ShunEnabledCommands;
 194         bool NotifyOfShun;
 195         bool affectopers;
 196
 197  public:
 198         ModuleShun() : cmd(this)
 199         {
 200                 ServerInstance->XLines->RegisterFactory(&f);
 201                 ServerInstance->AddCommand(&cmd);
 202
 203                 Implementation eventlist[] = { I_OnStats, I_OnPreCommand, I_OnUserConnect, I_OnRehash };
 204                 ServerInstance->Modules->Attach(eventlist, this, 4);
 205                 OnRehash(NULL);
 206         }
 207
 208         virtual ~ModuleShun()
 209         {
 210                 ServerInstance->XLines->DelAll("SHUN");
 211                 ServerInstance->XLines->UnregisterFactory(&f);
 212         }
 213
 214         void Prioritize()
 215         {
 216                 Module* alias = ServerInstance->Modules->Find("m_alias.so");
 217                 ServerInstance->Modules->SetPriority(this, I_OnPreCommand, PRIORITY_BEFORE, &alias);
 218         }
 219
 220         virtual ModResult OnStats(char symbol, User* user, string_list& out)
 221         {
 222                 if (symbol != 'H')
 223                         return MOD_RES_PASSTHRU;
 224
 225                 ServerInstance->XLines->InvokeStats("SHUN", 223, user, out);
 226                 return MOD_RES_DENY;
 227         }
 228
 229         virtual void OnRehash(User* user)
 230         {
 231                 ConfigReader MyConf;
 232                 std::string cmds = MyConf.ReadValue("shun", "enabledcommands", 0);
 233
 234                 if (cmds.empty())
 235                         cmds = "PING PONG QUIT";
 236
 237                 ShunEnabledCommands.clear();
 238                 NotifyOfShun = true;
 239                 affectopers = false;
 240
 241                 std::stringstream dcmds(cmds);
 242                 std::string thiscmd;
 243
 244                 while (dcmds >> thiscmd)
 245                 {
 246                         ShunEnabledCommands.insert(thiscmd);
 247                 }
 248
 249                 NotifyOfShun = MyConf.ReadFlag("shun", "notifyuser", "yes", 0);
 250                 affectopers = MyConf.ReadFlag("shun", "affectopers", "no", 0);
 251         }
 252
 253         virtual void OnUserConnect(LocalUser* user)
 254         {
 255                 if (!IS_LOCAL(user))
 256                         return;
 257
 258                 // Apply lines on user connect
 259                 XLine *rl = ServerInstance->XLines->MatchesLine("SHUN", user);
 260
 261                 if (rl)
 262                 {
 263                         // Bang. :P
 264                         rl->Apply(user);
 265                 }
 266         }
 267
 268         virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser* user, bool validated, const std::string &original_line)
 269         {
 270                 if (validated)
 271                         return MOD_RES_PASSTHRU;
 272
 273                 if (!ServerInstance->XLines->MatchesLine("SHUN", user))
 274                 {
 275                         /* Not shunned, don't touch. */
 276                         return MOD_RES_PASSTHRU;
 277                 }
 278
 279                 if (!affectopers && IS_OPER(user))
 280                 {
 281                         /* Don't do anything if the user is an operator and affectopers isn't set */
 282                         return MOD_RES_PASSTHRU;
 283                 }
 284
 285                 std::set<std::string>::iterator i = ShunEnabledCommands.find(command);
 286
 287                 if (i == ShunEnabledCommands.end())
 288                 {
 289                         if (NotifyOfShun)
 290                                 user->WriteServ("NOTICE %s :*** Command %s not processed, as you have been blocked from issuing commands (SHUN)", user->nick.c_str(), command.c_str());
 291                         return MOD_RES_DENY;
 292                 }
 293
 294                 if (command == "QUIT")
 295                 {
 296                         /* Allow QUIT but dont show any quit message */
 297                         parameters.clear();
 298                 }
 299                 else if (command == "PART")
 300                 {
 301                         /* same for PART */
 302                         parameters[1] = "";
 303                 }
 304
 305                 /* if we're here, allow the command. */
 306                 return MOD_RES_PASSTHRU;
 307         }
 308
 309         virtual Version GetVersion()
 310         {
 311                 return Version("Provides the /SHUN command, which stops a user from executing all except configured commands.",VF_VENDOR|VF_COMMON);
 312         }
 313 };
 314
 315 MODULE_INIT(ModuleShun)
 316