src/modules/m_shun.cpp

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