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