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