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