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