]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_cban.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_cban.cpp
index 7d80eb4caeb54da121a37ebd54a2f8efea2ebde4..c7960c836d0ca6a5a77d7143440b21b3c7d59c5c 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *   Copyright (C) 2020 Michael <michaelhazell@hotmail.com>
+ *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2013, 2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 John Brooks <special@inspircd.org>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2005, 2008 Robin Burchell <robin+git@viroteck.net>
  *
- * ---------------------------------------------------
+ * 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/>.
  */
 
-using namespace std;
 
-#include <stdio.h>
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "helperfuncs.h"
+#include "inspircd.h"
+#include "xline.h"
+#include "modules/stats.h"
 
-/* $ModDesc: Gives /cban, aka C:lines. Think Q:lines, for channels. */
+enum
+{
+       // InspIRCd-specific.
+       ERR_BADCHANNEL = 926
+};
 
-extern time_t TIME;
+// Compatibility: Use glob matching?
+// InspIRCd versions 3.7.0 and below use only exact matching
+static bool glob = false;
 
-class CBan
+/** Holds a CBAN item
+ */
+class CBan : public XLine
 {
- private:
-       unsigned long expiry;
-       std::string chname;
-       std::string reason;
+private:
+       std::string matchtext;
 
- public:
-       CBan(std::string cn, std::string rs, unsigned long ex)
+public:
+       CBan(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ch)
+               : XLine(s_time, d, src, re, "CBAN")
+               , matchtext(ch)
        {
-               chname = cn;
-               reason = rs;
-               expiry = ex;
        }
 
-       std::string GetName()
+       // XXX I shouldn't have to define this
+       bool Matches(User* u) CXX11_OVERRIDE
        {
-               return this->chname;
+               return false;
        }
 
-       std::string GetReason()
+       bool Matches(const std::string& s) CXX11_OVERRIDE
        {
-               return this->reason;
+               if (glob)
+                       return InspIRCd::Match(s, matchtext);
+               else
+                       return irc::equals(matchtext, s);
        }
 
-       unsigned long GetExpiry()
+       const std::string& Displayable() CXX11_OVERRIDE
        {
-               return this->expiry;
+               return matchtext;
        }
 };
 
-/* cbans is declared here, as our type is right above. Don't try move it. */
-vector<CBan> cbans;
-
-class cmd_cban : public command_t
+/** An XLineFactory specialized to generate cban pointers
+ */
+class CBanFactory : public XLineFactory
 {
- private:
-       Server *Srv;
+ public:
+       CBanFactory() : XLineFactory("CBAN") { }
+
+       /** Generate a CBAN
+       */
+       XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
+       {
+               return new CBan(set_time, duration, source, reason, xline_specific_mask);
+       }
+
+       bool AutoApplyToUserList(XLine* x) CXX11_OVERRIDE
+       {
+               return false; // No, we apply to channels.
+       }
+};
 
+/** Handle /CBAN
+ */
+class CommandCBan : public Command
+{
  public:
-       cmd_cban (Server* Me) : command_t("CBAN", 'o', 1)
+       CommandCBan(Module* Creator) : Command(Creator, "CBAN", 1, 3)
        {
-               this->source = "m_cban.so";
-               this->Srv = Me;
+               flags_needed = 'o';
+               this->syntax = "<channelmask> [<duration> [:<reason>]]";
        }
 
-       void Handle(char **parameters, int pcnt, userrec *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                /* syntax: CBAN #channel time :reason goes here */
                /* 'time' is a human-readable timestring, like 2d3h2s. */
 
-               std::string chname;
-               std::string reason;
-               unsigned long expiry;
+               if (parameters.size() == 1)
+               {
+                       std::string reason;
 
-               if (pcnt == 1)
+                       if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "CBAN", reason, user))
+                       {
+                               ServerInstance->SNO->WriteGlobalSno('x', "%s removed CBan on %s: %s", user->nick.c_str(), parameters[0].c_str(), reason.c_str());
+                       }
+                       else
+                       {
+                               user->WriteNotice("*** CBan " + parameters[0] + " not found on the list.");
+                               return CMD_FAILURE;
+                       }
+               }
+               else
                {
-                       /* form: CBAN #channel removes a CBAN */
-                       for (vector<CBan>::iterator myiter; myiter < cbans.end(); myiter++)
+                       // Adding - XXX todo make this respect <insane> tag perhaps..
+                       unsigned long duration;
+                       if (!InspIRCd::Duration(parameters[1], duration))
                        {
-                               if (parameters[0] == (*myiter).GetName())
+                               user->WriteNotice("*** Invalid duration for CBan.");
+                               return CMD_FAILURE;
+                       }
+                       const char *reason = (parameters.size() > 2) ? parameters[2].c_str() : "No reason supplied";
+                       CBan* r = new CBan(ServerInstance->Time(), duration, user->nick.c_str(), reason, parameters[0].c_str());
+
+                       if (ServerInstance->XLines->AddLine(r, user))
+                       {
+                               if (!duration)
                                {
-                                       cbans.erase(myiter);
-                                       break;
+                                       ServerInstance->SNO->WriteGlobalSno('x', "%s added permanent CBan for %s: %s", user->nick.c_str(), parameters[0].c_str(), reason);
+                               }
+                               else
+                               {
+                                       ServerInstance->SNO->WriteGlobalSno('x', "%s added timed CBan for %s, expires in %s (on %s): %s",
+                                               user->nick.c_str(), parameters[0].c_str(), InspIRCd::DurationString(duration).c_str(),
+                                               InspIRCd::TimeString(ServerInstance->Time() + duration).c_str(), reason);
                                }
                        }
+                       else
+                       {
+                               delete r;
+                               user->WriteNotice("*** CBan for " + parameters[0] + " already exists");
+                               return CMD_FAILURE;
+                       }
                }
-               else if (pcnt >= 2)
-               {
-                       /* full form to add a CBAN */
-                       /* XXX - checking on chnames */
-                       chname = parameters[0];
-                       expiry = TIME + Srv->CalcDuration(parameters[1]);
-                       reason = parameters[2];
-
-                       CBan meow(chname, reason, expiry);
-                       cbans.push_back(meow);
-               }
+               return CMD_SUCCESS;
+       }
+
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
+       {
+               if (IS_LOCAL(user))
+                       return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
+
+               return ROUTE_BROADCAST;
        }
 };
 
-class ModuleCBan : public Module
+class ModuleCBan : public Module, public Stats::EventListener
 {
-       cmd_cban* mycommand;
-       Server* Srv;
+       CommandCBan mycommand;
+       CBanFactory f;
 
  public:
-       ModuleCBan(Server* Me) : Module::Module(Me)
+       ModuleCBan()
+               : Stats::EventListener(this)
+               , mycommand(this)
        {
-               Srv = Me;
-               mycommand = new cmd_cban(Srv);
-               Srv->AddCommand(mycommand);
        }
 
-       virtual int OnUserPreJoin(userrec *user, chanrec *chan, const char *cname)
+       void init() CXX11_OVERRIDE
        {
-               /* check cbans in here, and apply as necessary. */
-               log(DEBUG,"In OnUserPreJoin cbans.size() == %d",cbans.size());
-
-               std::string chname = cname;
-
-               for (unsigned int a = 0; a < cbans.size(); a++)
-               {
-                       log(DEBUG,"m_cban: DEBUG: checking %s against %s in OnPreUserJoin()", chname.c_str(), cbans[a].GetName().c_str());
-                       if (chname == cbans[a].GetName())
-                       {
-                               /* matches CBAN */
-                               WriteOpers("DENY join");
-                               return 1;
-                       }
-               }
-
-               log(DEBUG,"DONE checking, allowed");
-
-               /* Allow the change. */
-               return 0;
+               ServerInstance->XLines->RegisterFactory(&f);
        }
 
-       virtual ~ModuleCBan()
+       ~ModuleCBan()
        {
+               ServerInstance->XLines->DelAll("CBAN");
+               ServerInstance->XLines->UnregisterFactory(&f);
        }
-       
-       virtual Version GetVersion()
+
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               return Version(1,0,0,0,VF_VENDOR);
-       }
-};
+               ConfigTag* tag = ServerInstance->Config->ConfValue("cban");
 
+               // XXX: Consider changing default behavior on the next major version
+               glob = tag->getBool("glob", false);
+       }
 
-class ModuleCBanFactory : public ModuleFactory
-{
- public:
-       ModuleCBanFactory()
+       ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
        {
+               if (stats.GetSymbol() != 'C')
+                       return MOD_RES_PASSTHRU;
+
+               ServerInstance->XLines->InvokeStats("CBAN", stats);
+               return MOD_RES_DENY;
        }
-       
-       ~ModuleCBanFactory()
+
+       ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
        {
+               XLine *rl = ServerInstance->XLines->MatchesLine("CBAN", cname);
+
+               if (rl)
+               {
+                       // Channel is banned.
+                       user->WriteNumeric(ERR_BADCHANNEL, cname, InspIRCd::Format("Channel %s is CBANed: %s", cname.c_str(), rl->reason.c_str()));
+                       ServerInstance->SNO->WriteGlobalSno('a', "%s tried to join %s which is CBANed (%s)",
+                               user->nick.c_str(), cname.c_str(), rl->reason.c_str());
+                       return MOD_RES_DENY;
+               }
+
+               return MOD_RES_PASSTHRU;
        }
-       
-       virtual Module * CreateModule(Server* Me)
+
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return new ModuleCBan(Me);
+               return Version("Adds the /CBAN command which allows server operators to prevent channels matching a glob from being created.", VF_COMMON | VF_VENDOR, glob ? "glob" : "");
        }
-       
 };
 
-
-extern "C" void * init_module( void )
-{
-       return new ModuleCBanFactory;
-}
-
+MODULE_INIT(ModuleCBan)