src/modules/m_cban.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2020 Michael <michaelhazell@hotmail.com>
   5  *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
   6  *   Copyright (C) 2018 linuxdaemon <linuxdaemon.irc@gmail.com>
   7  *   Copyright (C) 2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
   8  *   Copyright (C) 2012-2013, 2016 Attila Molnar <attilamolnar@hush.com>
   9  *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
  10  *   Copyright (C) 2009 John Brooks <special@inspircd.org>
  11  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
  12  *   Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
  13  *   Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
  14  *   Copyright (C) 2005, 2008 Robin Burchell <robin+git@viroteck.net>
  15  *
  16  * This file is part of InspIRCd.  InspIRCd is free software: you can
  17  * redistribute it and/or modify it under the terms of the GNU General Public
  18  * License as published by the Free Software Foundation, version 2.
  19  *
  20  * This program is distributed in the hope that it will be useful, but WITHOUT
  21  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  22  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  23  * details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  27  */
  28
  29
  30 #include "inspircd.h"
  31 #include "xline.h"
  32 #include "modules/stats.h"
  33
  34 enum
  35 {
  36         // InspIRCd-specific.
  37         ERR_BADCHANNEL = 926
  38 };
  39
  40 // Compatibility: Use glob matching?
  41 // InspIRCd versions 3.7.0 and below use only exact matching
  42 static bool glob = false;
  43
  44 /** Holds a CBAN item
  45  */
  46 class CBan : public XLine
  47 {
  48 private:
  49         std::string matchtext;
  50
  51 public:
  52         CBan(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ch)
  53                 : XLine(s_time, d, src, re, "CBAN")
  54                 , matchtext(ch)
  55         {
  56         }
  57
  58         // XXX I shouldn't have to define this
  59         bool Matches(User* u) CXX11_OVERRIDE
  60         {
  61                 return false;
  62         }
  63
  64         bool Matches(const std::string& s) CXX11_OVERRIDE
  65         {
  66                 if (glob)
  67                         return InspIRCd::Match(s, matchtext);
  68                 else
  69                         return irc::equals(matchtext, s);
  70         }
  71
  72         const std::string& Displayable() CXX11_OVERRIDE
  73         {
  74                 return matchtext;
  75         }
  76 };
  77
  78 /** An XLineFactory specialized to generate cban pointers
  79  */
  80 class CBanFactory : public XLineFactory
  81 {
  82  public:
  83         CBanFactory() : XLineFactory("CBAN") { }
  84
  85         /** Generate a CBAN
  86         */
  87         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
  88         {
  89                 return new CBan(set_time, duration, source, reason, xline_specific_mask);
  90         }
  91
  92         bool AutoApplyToUserList(XLine* x) CXX11_OVERRIDE
  93         {
  94                 return false; // No, we apply to channels.
  95         }
  96 };
  97
  98 /** Handle /CBAN
  99  */
 100 class CommandCBan : public Command
 101 {
 102  public:
 103         CommandCBan(Module* Creator) : Command(Creator, "CBAN", 1, 3)
 104         {
 105                 flags_needed = 'o';
 106                 this->syntax = "<channelmask> [<duration> [:<reason>]]";
 107         }
 108
 109         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
 110         {
 111                 /* syntax: CBAN #channel time :reason goes here */
 112                 /* 'time' is a human-readable timestring, like 2d3h2s. */
 113
 114                 if (parameters.size() == 1)
 115                 {
 116                         std::string reason;
 117
 118                         if (ServerInstance->XLines->DelLine(parameters[0].c_str(), "CBAN", reason, user))
 119                         {
 120                                 ServerInstance->SNO->WriteGlobalSno('x', "%s removed CBan on %s: %s", user->nick.c_str(), parameters[0].c_str(), reason.c_str());
 121                         }
 122                         else
 123                         {
 124                                 user->WriteNotice("*** CBan " + parameters[0] + " not found on the list.");
 125                                 return CMD_FAILURE;
 126                         }
 127                 }
 128                 else
 129                 {
 130                         // Adding - XXX todo make this respect <insane> tag perhaps..
 131                         unsigned long duration;
 132                         if (!InspIRCd::Duration(parameters[1], duration))
 133                         {
 134                                 user->WriteNotice("*** Invalid duration for CBan.");
 135                                 return CMD_FAILURE;
 136                         }
 137                         const char *reason = (parameters.size() > 2) ? parameters[2].c_str() : "No reason supplied";
 138                         CBan* r = new CBan(ServerInstance->Time(), duration, user->nick.c_str(), reason, parameters[0].c_str());
 139
 140                         if (ServerInstance->XLines->AddLine(r, user))
 141                         {
 142                                 if (!duration)
 143                                 {
 144                                         ServerInstance->SNO->WriteGlobalSno('x', "%s added permanent CBan for %s: %s", user->nick.c_str(), parameters[0].c_str(), reason);
 145                                 }
 146                                 else
 147                                 {
 148                                         ServerInstance->SNO->WriteGlobalSno('x', "%s added timed CBan for %s, expires in %s (on %s): %s",
 149                                                 user->nick.c_str(), parameters[0].c_str(), InspIRCd::DurationString(duration).c_str(),
 150                                                 InspIRCd::TimeString(ServerInstance->Time() + duration).c_str(), reason);
 151                                 }
 152                         }
 153                         else
 154                         {
 155                                 delete r;
 156                                 user->WriteNotice("*** CBan for " + parameters[0] + " already exists");
 157                                 return CMD_FAILURE;
 158                         }
 159                 }
 160                 return CMD_SUCCESS;
 161         }
 162
 163         RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
 164         {
 165                 if (IS_LOCAL(user))
 166                         return ROUTE_LOCALONLY; // spanningtree will send ADDLINE
 167
 168                 return ROUTE_BROADCAST;
 169         }
 170 };
 171
 172 class ModuleCBan : public Module, public Stats::EventListener
 173 {
 174         CommandCBan mycommand;
 175         CBanFactory f;
 176
 177  public:
 178         ModuleCBan()
 179                 : Stats::EventListener(this)
 180                 , mycommand(this)
 181         {
 182         }
 183
 184         void init() CXX11_OVERRIDE
 185         {
 186                 ServerInstance->XLines->RegisterFactory(&f);
 187         }
 188
 189         ~ModuleCBan()
 190         {
 191                 ServerInstance->XLines->DelAll("CBAN");
 192                 ServerInstance->XLines->UnregisterFactory(&f);
 193         }
 194
 195         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 196         {
 197                 ConfigTag* tag = ServerInstance->Config->ConfValue("cban");
 198
 199                 // XXX: Consider changing default behavior on the next major version
 200                 glob = tag->getBool("glob", false);
 201         }
 202
 203         ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE
 204         {
 205                 if (stats.GetSymbol() != 'C')
 206                         return MOD_RES_PASSTHRU;
 207
 208                 ServerInstance->XLines->InvokeStats("CBAN", stats);
 209                 return MOD_RES_DENY;
 210         }
 211
 212         ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
 213         {
 214                 XLine *rl = ServerInstance->XLines->MatchesLine("CBAN", cname);
 215
 216                 if (rl)
 217                 {
 218                         // Channel is banned.
 219                         user->WriteNumeric(ERR_BADCHANNEL, cname, InspIRCd::Format("Channel %s is CBANed: %s", cname.c_str(), rl->reason.c_str()));
 220                         ServerInstance->SNO->WriteGlobalSno('a', "%s tried to join %s which is CBANed (%s)",
 221                                 user->nick.c_str(), cname.c_str(), rl->reason.c_str());
 222                         return MOD_RES_DENY;
 223                 }
 224
 225                 return MOD_RES_PASSTHRU;
 226         }
 227
 228         Version GetVersion() CXX11_OVERRIDE
 229         {
 230                 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" : "");
 231         }
 232 };
 233
 234 MODULE_INIT(ModuleCBan)