]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_svshold.cpp
Convert WriteNumeric() calls to pass the parameters of the numeric as method parameters
[user/henk/code/inspircd.git] / src / modules / m_svshold.cpp
index 61665508540a1e5bbe6f07156cc06772d1410d52..b95a847a5cbbd9c99997ea1869decb01dab3f526 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ *   Copyright (C) 2006-2008 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 #include "inspircd.h"
-#include <algorithm>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "configreader.h"
+#include "xline.h"
 
-/* $ModDesc: Implements SVSHOLD. Like Q:Lines, but can only be added/removed by Services. */
+namespace
+{
+       bool silent;
+}
 
 /** Holds a SVSHold item
  */
-class SVSHold : public classbase
+class SVSHold : public XLine
 {
 public:
        std::string nickname;
-       std::string set_by;
-       time_t set_on;
-       long length;
-       std::string reason;
 
-       SVSHold()
+       SVSHold(time_t s_time, long d, const std::string& src, const std::string& re, const std::string& nick)
+               : XLine(s_time, d, src, re, "SVSHOLD")
        {
+               this->nickname = nick;
        }
 
-       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)
+       bool Matches(User *u)
        {
+               if (u->nick == nickname)
+                       return true;
+               return false;
        }
-};
 
+       bool Matches(const std::string &s)
+       {
+               return InspIRCd::Match(s, nickname);
+       }
 
-bool SVSHoldComp(const SVSHold* ban1, const SVSHold* ban2);
+       void DisplayExpiry()
+       {
+               if (!silent)
+               {
+                       ServerInstance->SNO->WriteToSnoMask('x', "Removing expired SVSHOLD %s (set by %s %ld seconds ago)",
+                               nickname.c_str(), source.c_str(), (long)(ServerInstance->Time() - set_time));
+               }
+       }
 
-typedef std::vector<SVSHold*> SVSHoldlist;
-typedef std::map<irc::string, SVSHold*> SVSHoldMap;
+       const std::string& Displayable()
+       {
+               return nickname;
+       }
+};
 
-/* SVSHolds is declared here, as our type is right above. Don't try move it. */
-SVSHoldlist SVSHolds;
-SVSHoldMap HoldMap;
+/** An XLineFactory specialized to generate SVSHOLD pointers
+ */
+class SVSHoldFactory : public XLineFactory
+{
+ public:
+       SVSHoldFactory() : XLineFactory("SVSHOLD") { }
+
+       /** Generate a shun
+       */
+       XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask)
+       {
+               return new SVSHold(set_time, duration, source, reason, xline_specific_mask);
+       }
+
+       bool AutoApplyToUserList(XLine *x)
+       {
+               return false;
+       }
+};
 
 /** Handle /SVSHold
  */
-class cmd_svshold : public command_t
+class CommandSvshold : public Command
 {
  public:
-       cmd_svshold(InspIRCd* Me) : command_t(Me, "SVSHOLD", 'o', 1)
+       CommandSvshold(Module* Creator) : Command(Creator, "SVSHOLD", 1)
        {
-               this->source = "m_svshold.so";
-               this->syntax = "<nickname> [<duration> :<reason>]";
+               flags_needed = 'o'; this->syntax = "<nickname> [<duration> :<reason>]";
        }
 
-       CmdResult Handle(const char** parameters, int pcnt, userrec *user)
+       CmdResult Handle(const std::vector<std::string> &parameters, User *user)
        {
                /* syntax: svshold nickname time :reason goes here */
                /* 'time' is a human-readable timestring, like 2d3h2s. */
 
-               if (!ServerInstance->ULine(user->server))
+               if (!user->server->IsULine())
                {
                        /* don't allow SVSHOLD from non-ulined clients */
                        return CMD_FAILURE;
                }
 
-               if (pcnt == 1)
+               if (parameters.size() == 1)
                {
-                       SVSHoldMap::iterator n = HoldMap.find(parameters[0]);
-                       if (n != HoldMap.end())
+                       if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "SVSHOLD", user))
                        {
-                               /* form: svshold nickname removes a hold. */
-                               for (SVSHoldlist::iterator iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
-                               {
-                                       if (parameters[0] == assign((*iter)->nickname))
-                                       {
-                                               unsigned long remaining = 0;
-                                               if ((*iter)->length)
-                                               {
-                                                       remaining = ((*iter)->set_on + (*iter)->length) - ServerInstance->Time();
-                                                       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());
-                                               }
-                                               else
-                                               {
-                                                       user->WriteServ( "386 %s %s :Removed permanent SVSHOLD (%s)", user->nick, (*iter)->nickname.c_str(), (*iter)->reason.c_str());
-                                               }
-                                               SVSHolds.erase(iter);
-                                               break;
-                                       }
-                               }
-
-                               HoldMap.erase(n);
-                               delete n->second;
+                               if (!silent)
+                                       ServerInstance->SNO->WriteToSnoMask('x',"%s removed SVSHOLD on %s",user->nick.c_str(),parameters[0].c_str());
+                       }
+                       else
+                       {
+                               user->WriteNotice("*** SVSHOLD " + parameters[0] + " not found in list, try /stats S.");
                        }
                }
-               else if (pcnt >= 2)
+               else
                {
-                       /* full form to add a SVSHold */
-                       if (ServerInstance->IsNick(parameters[0]))
-                       {
-                               // parameters[0] = w00t
-                               // parameters[1] = 1h3m2s
-                               // parameters[2] = Registered nickname
-                               
-                               /* Already exists? */
-                               if (HoldMap.find(parameters[0]) != HoldMap.end())
-                               {
-                                       user->WriteServ( "385 %s %s :SVSHOLD already exists", user->nick, parameters[0]);
-                                       return CMD_FAILURE;
-                               }
+                       if (parameters.size() < 3)
+                               return CMD_FAILURE;
 
-                               long length = ServerInstance->Duration(parameters[1]);
-                               std::string reason = (pcnt > 2) ? parameters[2] : "No reason supplied";
-                               
-                               SVSHold* S = new SVSHold(parameters[0], user->nick, ServerInstance->Time(), length, reason);
-                               SVSHolds.push_back(S);
-                               HoldMap[parameters[0]] = S;
+                       unsigned long duration = InspIRCd::Duration(parameters[1]);
+                       SVSHold* r = new SVSHold(ServerInstance->Time(), duration, user->nick.c_str(), parameters[2].c_str(), parameters[0].c_str());
 
-                               std::sort(SVSHolds.begin(), SVSHolds.end(), SVSHoldComp);
+                       if (ServerInstance->XLines->AddLine(r, user))
+                       {
+                               if (silent)
+                                       return CMD_SUCCESS;
 
-                               if(length > 0)
+                               if (!duration)
                                {
-                                       user->WriteServ( "385 %s %s :Added %lu second SVSHOLD (%s)", user->nick, parameters[0], length, reason.c_str());
-                                       ServerInstance->WriteOpers("*** %s added %lu second SVSHOLD on %s (%s)", user->nick, length, parameters[0], reason.c_str());
+                                       ServerInstance->SNO->WriteGlobalSno('x', "%s added permanent SVSHOLD for %s: %s", user->nick.c_str(), parameters[0].c_str(), parameters[2].c_str());
                                }
                                else
                                {
-                                       user->WriteServ( "385 %s %s :Added permanent SVSHOLD on %s (%s)", user->nick, parameters[0], parameters[0], reason.c_str());
-                                       ServerInstance->WriteOpers("*** %s added permanent SVSHOLD on %s (%s)", user->nick, parameters[0], reason.c_str());
+                                       time_t c_requires_crap = duration + ServerInstance->Time();
+                                       std::string timestr = InspIRCd::TimeString(c_requires_crap);
+                                       ServerInstance->SNO->WriteGlobalSno('x', "%s added timed SVSHOLD for %s, expires on %s: %s", user->nick.c_str(), parameters[0].c_str(), timestr.c_str(), parameters[2].c_str());
                                }
                        }
                        else
                        {
-                               /* as this is primarily a Services command, do not provide an error */
+                               delete r;
                                return CMD_FAILURE;
                        }
                }
 
                return CMD_SUCCESS;
        }
-};
 
-bool SVSHoldComp(const SVSHold* ban1, const SVSHold* ban2)
-{
-       return ((ban1->set_on + ban1->length) < (ban2->set_on + ban2->length));
-}
+       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       {
+               return ROUTE_BROADCAST;
+       }
+};
 
 class ModuleSVSHold : public Module
 {
-       cmd_svshold *mycommand;
-       
+       CommandSvshold cmd;
+       SVSHoldFactory s;
+
 
  public:
-       ModuleSVSHold(InspIRCd* Me) : Module(Me)
+       ModuleSVSHold() : cmd(this)
        {
-               mycommand = new cmd_svshold(Me);
-               ServerInstance->AddCommand(mycommand);
        }
 
-       void Implements(char* List)
+       void init() CXX11_OVERRIDE
        {
-               List[I_OnUserPreNick] = List[I_OnSyncOtherMetaData] = List[I_OnDecodeMetaData] = List[I_OnStats] = 1;
-       }
-       
-       virtual int OnStats(char symbol, userrec* user, string_list &results)
-       {
-               ExpireBans();
-       
-               if(symbol == 'S')
-               {
-                       for(SVSHoldlist::iterator iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
-                       {
-                               unsigned long remaining = ((*iter)->set_on + (*iter)->length) - ServerInstance->Time();
-                               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);
-                       }
-               }
-               
-               return 0;
+               ServerInstance->XLines->RegisterFactory(&s);
        }
 
-       virtual int OnUserPreNick(userrec *user, const std::string &newnick)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               ExpireBans();
-       
-               /* check SVSHolds in here, and apply as necessary. */
-               SVSHoldMap::iterator n = HoldMap.find(assign(newnick));
-               if (n != HoldMap.end())
-               {
-                       user->WriteServ( "432 %s %s :Reserved nickname: %s", user->nick, newnick.c_str(), n->second->reason.c_str());
-                       return 1;
-               }
-               return 0;
+               ConfigTag* tag = ServerInstance->Config->ConfValue("svshold");
+               silent = tag->getBool("silent", true);
        }
-       
-       virtual void OnSyncOtherMetaData(Module* proto, void* opaque, bool displayable)
+
+       ModResult OnStats(char symbol, User* user, string_list &out) CXX11_OVERRIDE
        {
-               for(SVSHoldMap::iterator iter = HoldMap.begin(); iter != HoldMap.end(); iter++)
-               {
-                       proto->ProtoSendMetaData(opaque, TYPE_OTHER, NULL, "SVSHold", EncodeSVSHold(iter->second));
-               }
+               if(symbol != 'S')
+                       return MOD_RES_PASSTHRU;
+
+               ServerInstance->XLines->InvokeStats("SVSHOLD", 210, user, out);
+               return MOD_RES_DENY;
        }
 
-       virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
+       ModResult OnUserPreNick(LocalUser* user, const std::string& newnick) CXX11_OVERRIDE
        {
-               if((target_type == TYPE_OTHER) && (extname == "SVSHold"))
+               XLine *rl = ServerInstance->XLines->MatchesLine("SVSHOLD", newnick);
+
+               if (rl)
                {
-                       SVSHold* S = DecodeSVSHold(extdata); /* NOTE: Allocates a new SVSHold* */
-                       if (HoldMap.find(assign(S->nickname)) == HoldMap.end())
-                       {
-                               SVSHolds.push_back(S);
-                               HoldMap[assign(S->nickname)] = S;
-                               std::sort(SVSHolds.begin(), SVSHolds.end(), SVSHoldComp);
-                       }
-                       else
-                       {
-                               delete S;
-                       }
+                       user->WriteNumeric(ERR_ERRONEUSNICKNAME, newnick, InspIRCd::Format("Services reserved nickname: %s", rl->reason.c_str()));
+                       return MOD_RES_DENY;
                }
-       }
-
-       virtual ~ModuleSVSHold()
-       {
-       }
-       
-       virtual Version GetVersion()
-       {
-               return Version(1, 1, 0, 1, VF_COMMON | VF_VENDOR, API_VERSION);
-       }
 
-       std::string EncodeSVSHold(const SVSHold* ban)
-       {
-               std::ostringstream stream;      
-               stream << ban->nickname << " " << ban->set_by << " " << ban->set_on << " " << ban->length << " :" << ban->reason;
-               return stream.str();    
+               return MOD_RES_PASSTHRU;
        }
 
-       SVSHold* DecodeSVSHold(const std::string &data)
+       ~ModuleSVSHold()
        {
-               SVSHold* res = new SVSHold();
-               int set_on;
-               irc::tokenstream tokens(data);
-               tokens.GetToken(res->nickname);
-               tokens.GetToken(res->set_by);
-               tokens.GetToken(set_on);
-               res->set_on = set_on;
-               tokens.GetToken(res->length);
-               tokens.GetToken(res->reason);
-               return res;
+               ServerInstance->XLines->DelAll("SVSHOLD");
+               ServerInstance->XLines->UnregisterFactory(&s);
        }
 
-       void ExpireBans()
+       Version GetVersion() CXX11_OVERRIDE
        {
-               SVSHoldlist::iterator iter,safeiter;
-               for (iter = SVSHolds.begin(); iter != SVSHolds.end(); iter++)
-               {
-                       /* 0 == permanent, don't mess with them! -- w00t */
-                       if ((*iter)->length != 0)
-                       {
-                               if ((*iter)->set_on + (*iter)->length <= ServerInstance->Time())
-                               {
-                                       ServerInstance->Log(DEBUG, "m_svshold.so: hold on %s expired, removing...", (*iter)->nickname.c_str());
-                                       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);
-                                       HoldMap.erase(assign((*iter)->nickname));
-                                       delete *iter;
-                                       safeiter = iter;
-                                       --iter;
-                                       SVSHolds.erase(safeiter);
-                               }
-                       }
-               }
+               return Version("Implements SVSHOLD. Like Q:Lines, but can only be added/removed by Services.", VF_COMMON | VF_VENDOR);
        }
 };