src/modules/m_svshold.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 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 <algorithm>
  15 #include "users.h"
  16 #include "channels.h"
  17 #include "modules.h"
  18 #include "configreader.h"
  19 #include "inspircd.h"
  20
  21 /* $ModDesc: Implements SVSHOLD. Like Q:Lines, but can only be added/removed by Services. */
  22
  23 /** Holds a SVSHold item
  24  */
  25 class SVSHold : public classbase
  26 {
  27 public:
  28         std::string nickname;
  29         std::string set_by;
  30         time_t set_on;
  31         long length;
  32         std::string reason;
  33
  34         SVSHold()
  35         {
  36         }
  37
  38         SVSHold(const std::string &nn, const std::string &sb, const time_t so, const long ln, const std::string &rs) : nickname(nn), set_by(sb), set_on(so), length(ln), reason(rs)
  39         {
  40         }
  41 };
  42
  43
  44 bool SVSHoldComp(const SVSHold* ban1, const SVSHold* ban2);
  45
  46 typedef std::vector<SVSHold*> SVSHoldlist;
  47 typedef std::map<irc::string, SVSHold*> SVSHoldMap;
  48
  49 /* SVSHolds is declared here, as our type is right above. Don't try move it. */
  50 SVSHoldlist SVSHolds;
  51 SVSHoldMap HoldMap;
  52
  53 /** Handle /SVSHold
  54  */
  55 class cmd_svshold : public command_t
  56 {
  57  public:
  58         cmd_svshold(InspIRCd* Me) : command_t(Me, "SVSHOLD", 'o', 1)
  59         {
  60                 this->source = "m_svshold.so";
  61                 this->syntax = "<nickname> [<duration> :<reason>]";
  62         }
  63
  64         CmdResult Handle(const char** parameters, int pcnt, userrec *user)
  65         {
  66                 /* syntax: svshold nickname time :reason goes here */
  67                 /* 'time' is a human-readable timestring, like 2d3h2s. */
  68
  69                 if (pcnt == 1)
  70                 {
  71                         SVSHoldMap::iterator n = HoldMap.find(parameters[0]);
  72                         if (n != HoldMap.end())
  73                         {
  74                                 /* form: svshold nickname removes a hold. */
  75                                 for (SVSHoldlist::iterator iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
  76                                 {
  77                                         if (parameters[0] == assign((*iter)->nickname))
  78                                         {
  79                                                 unsigned long remaining = 0;
  80                                                 if ((*iter)->length)
  81                                                 {
  82                                                         remaining = ((*iter)->set_on + (*iter)->length) - ServerInstance->Time();
  83                                                         user->WriteServ( "386 %s %s :Removed SVSHOLD with %lu seconds left before expiry (%s)", user->nick, (*iter)->nickname.c_str(), remaining, (*iter)->reason.c_str());
  84                                                 }
  85                                                 else
  86                                                 {
  87                                                         user->WriteServ( "386 %s %s :Removed permenant SVSHOLD (%s)", user->nick, (*iter)->nickname.c_str(), (*iter)->reason.c_str());
  88                                                 }
  89                                                 SVSHolds.erase(iter);
  90                                                 break;
  91                                         }
  92                                 }
  93
  94                                 HoldMap.erase(n);
  95                                 delete n->second;
  96                         }
  97                 }
  98                 else if (pcnt >= 2)
  99                 {
 100                         /* full form to add a SVSHold */
 101                         if (ServerInstance->IsNick(parameters[0]))
 102                         {
 103                                 // parameters[0] = w00t
 104                                 // parameters[1] = 1h3m2s
 105                                 // parameters[2] = Registered nickname
 106
 107                                 /* Already exists? */
 108                                 if (HoldMap.find(parameters[0]) != HoldMap.end())
 109                                 {
 110                                         user->WriteServ( "385 %s %s :SVSHOLD already exists", user->nick, parameters[0]);
 111                                         return CMD_FAILURE;
 112                                 }
 113
 114                                 long length = ServerInstance->Duration(parameters[1]);
 115                                 std::string reason = (pcnt > 2) ? parameters[2] : "No reason supplied";
 116
 117                                 SVSHold* S = new SVSHold(parameters[0], user->nick, ServerInstance->Time(), length, reason);
 118                                 SVSHolds.push_back(S);
 119                                 HoldMap[parameters[0]] = S;
 120
 121                                 std::sort(SVSHolds.begin(), SVSHolds.end(), SVSHoldComp);
 122
 123                                 if(length > 0)
 124                                 {
 125                                         user->WriteServ( "385 %s %s :Added %lu second SVSHOLD (%s)", user->nick, parameters[0], length, reason.c_str());
 126                                         ServerInstance->WriteOpers("*** %s added %lu second SVSHOLD on %s (%s)", user->nick, length, parameters[0], reason.c_str());
 127                                 }
 128                                 else
 129                                 {
 130                                         user->WriteServ( "385 %s %s :Added permanent SVSHOLD on %s (%s)", user->nick, parameters[0], parameters[0], reason.c_str());
 131                                         ServerInstance->WriteOpers("*** %s added permanent SVSHOLD on %s (%s)", user->nick, parameters[0], reason.c_str());
 132                                 }
 133                         }
 134                         else
 135                         {
 136                                 /* as this is primarily a Services command, do not provide an error */
 137                                 return CMD_FAILURE;
 138                         }
 139                 }
 140
 141                 return CMD_SUCCESS;
 142         }
 143 };
 144
 145 bool SVSHoldComp(const SVSHold* ban1, const SVSHold* ban2)
 146 {
 147         return ((ban1->set_on + ban1->length) < (ban2->set_on + ban2->length));
 148 }
 149
 150 class ModuleSVSHold : public Module
 151 {
 152         cmd_svshold *mycommand;
 153
 154
 155  public:
 156         ModuleSVSHold(InspIRCd* Me) : Module::Module(Me)
 157         {
 158                 mycommand = new cmd_svshold(Me);
 159                 ServerInstance->AddCommand(mycommand);
 160         }
 161
 162         void Implements(char* List)
 163         {
 164                 List[I_OnUserPreNick] = List[I_OnSyncOtherMetaData] = List[I_OnDecodeMetaData] = List[I_OnStats] = 1;
 165         }
 166
 167         virtual int OnStats(char symbol, userrec* user, string_list &results)
 168         {
 169                 ExpireBans();
 170
 171                 if(symbol == 'S')
 172                 {
 173                         for(SVSHoldlist::iterator iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
 174                         {
 175                                 unsigned long remaining = ((*iter)->set_on + (*iter)->length) - ServerInstance->Time();
 176                                 results.push_back(std::string(ServerInstance->Config->ServerName)+" 210 "+user->nick+" "+(*iter)->nickname.c_str()+" "+(*iter)->set_by+" "+ConvToStr((*iter)->set_on)+" "+ConvToStr((*iter)->length)+" "+ConvToStr(remaining)+" :"+(*iter)->reason);
 177                         }
 178                 }
 179
 180                 return 0;
 181         }
 182
 183         virtual int OnUserPreNick(userrec *user, const std::string &newnick)
 184         {
 185                 ExpireBans();
 186
 187                 /* check SVSHolds in here, and apply as necessary. */
 188                 SVSHoldMap::iterator n = HoldMap.find(assign(newnick));
 189                 if (n != HoldMap.end())
 190                 {
 191                         user->WriteServ( "432 %s %s :Reserved nickname: %s", user->nick, newnick.c_str(), n->second->reason.c_str());
 192                         return 1;
 193                 }
 194                 return 0;
 195         }
 196
 197         virtual void OnSyncOtherMetaData(Module* proto, void* opaque)
 198         {
 199                 for(SVSHoldMap::iterator iter = HoldMap.begin(); iter != HoldMap.end(); iter++)
 200                 {
 201                         proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "SVSHold", EncodeSVSHold(iter->second));
 202                 }
 203         }
 204
 205         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 206         {
 207                 if((target_type == TYPE_OTHER) && (extname == "SVSHold"))
 208                 {
 209                         SVSHold* S = DecodeSVSHold(extdata); /* NOTE: Allocates a new SVSHold* */
 210                         if (HoldMap.find(assign(S->nickname)) == HoldMap.end())
 211                         {
 212                                 SVSHolds.push_back(S);
 213                                 HoldMap[assign(S->nickname)] = S;
 214                                 std::sort(SVSHolds.begin(), SVSHolds.end(), SVSHoldComp);
 215                         }
 216                         else
 217                         {
 218                                 delete S;
 219                         }
 220                 }
 221         }
 222
 223         virtual ~ModuleSVSHold()
 224         {
 225         }
 226
 227         virtual Version GetVersion()
 228         {
 229                 return Version(1,1,0,1,VF_VENDOR|VF_COMMON,API_VERSION);
 230         }
 231
 232         std::string EncodeSVSHold(const SVSHold* ban)
 233         {
 234                 std::ostringstream stream;
 235                 stream << ban->nickname << " " << ban->set_by << " " << ban->set_on << " " << ban->length << " " << ban->reason;
 236                 return stream.str();
 237         }
 238
 239         SVSHold* DecodeSVSHold(const std::string &data)
 240         {
 241                 SVSHold* res = new SVSHold();
 242                 std::istringstream stream(data);
 243                 stream >> res->nickname;
 244                 stream >> res->set_by;
 245                 stream >> res->set_on;
 246                 stream >> res->length;
 247                 res->reason = stream.str();
 248                 return res;
 249         }
 250
 251         void ExpireBans()
 252         {
 253                 SVSHoldlist::iterator iter,safeiter;
 254                 for (iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
 255                 {
 256                         /* 0 == permanent, don't mess with them! -- w00t */
 257                         if ((*iter)->length != 0)
 258                         {
 259                                 if ((*iter)->set_on + (*iter)->length <= ServerInstance->Time())
 260                                 {
 261                                         ServerInstance->Log(DEBUG, "m_svshold.so: hold on %s expired, removing...", (*iter)->nickname.c_str());
 262                                         ServerInstance->WriteOpers("*** %li second SVSHOLD on %s (%s) set %u seconds ago expired", (*iter)->length, (*iter)->nickname.c_str(), (*iter)->reason.c_str(), ServerInstance->Time() - (*iter)->set_on);
 263                                         HoldMap.erase(assign((*iter)->nickname));
 264                                         delete *iter;
 265                                         safeiter = iter;
 266                                         --iter;
 267                                         SVSHolds.erase(safeiter);
 268                                 }
 269                         }
 270                 }
 271         }
 272 };
 273
 274 class ModuleSVSHoldFactory : public ModuleFactory
 275 {
 276  public:
 277         ModuleSVSHoldFactory()
 278         {
 279         }
 280
 281         ~ModuleSVSHoldFactory()
 282         {
 283         }
 284
 285         virtual Module * CreateModule(InspIRCd* Me)
 286         {
 287                 return new ModuleSVSHold(Me);
 288         }
 289
 290 };
 291
 292
 293 extern "C" void * init_module( void )
 294 {
 295         return new ModuleSVSHoldFactory;
 296 }