src/modules/m_shun.cpp

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