src/modules/m_cban.cpp

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