src/modules/m_ojoin.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 /*
  21  * Written for InspIRCd-1.2 by Taros on the Tel'Laerad M&D Team
  22  * <http://tellaerad.net>
  23  */
  24
  25 #include "inspircd.h"
  26
  27 /* $ModConfig: <ojoin prefix="!" notice="yes" op="yes">
  28  *  Specify the prefix that +Y will grant here, it should be unused.
  29  *  Leave prefix empty if you do not wish +Y to grant a prefix
  30  *  If notice is set to on, upon ojoin, the server will notice
  31  *  the channel saying that the oper is joining on network business
  32  *  If op is set to on, it will give them +o along with +Y */
  33 /* $ModDesc: Provides the /ojoin command, which joins a user to a channel on network business, and gives them +Y, which makes them immune to kick / deop and so on. */
  34 /* $ModAuthor: Taros */
  35 /* $ModAuthorMail: taros34@hotmail.com */
  36
  37 /* A note: This will not protect against kicks from services,
  38  * ulines, or operoverride. */
  39
  40 #define NETWORK_VALUE 9000000
  41
  42 char NPrefix;
  43 bool notice;
  44 bool op;
  45
  46 /** Handle /OJOIN
  47  */
  48 class CommandOjoin : public SplitCommand
  49 {
  50  public:
  51         bool active;
  52         CommandOjoin(Module* parent) :
  53                 SplitCommand(parent, "OJOIN", 1)
  54         {
  55                 flags_needed = 'o'; Penalty = 0; syntax = "<channel>";
  56                 active = false;
  57                 TRANSLATE3(TR_NICK, TR_TEXT, TR_END);
  58         }
  59
  60         CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user)
  61         {
  62                 // Make sure the channel name is allowable.
  63                 if (!ServerInstance->IsChannel(parameters[0]))
  64                 {
  65                         user->WriteNotice("*** Invalid characters in channel name or name too long");
  66                         return CMD_FAILURE;
  67                 }
  68
  69                 active = true;
  70                 // override is false because we want OnUserPreJoin to run
  71                 Channel* channel = Channel::JoinUser(user, parameters[0], false);
  72                 active = false;
  73
  74                 if (channel)
  75                 {
  76                         ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used OJOIN to join "+channel->name);
  77
  78                         if (notice)
  79                         {
  80                                 channel = ServerInstance->FindChan(parameters[0]);
  81                                 channel->WriteChannelWithServ(ServerInstance->Config->ServerName, "NOTICE %s :%s joined on official network business.",
  82                                         parameters[0].c_str(), user->nick.c_str());
  83                                 ServerInstance->PI->SendChannelNotice(channel, 0, user->nick + " joined on official network business.");
  84                         }
  85                 }
  86                 else
  87                 {
  88                         ServerInstance->SNO->WriteGlobalSno('a', user->nick+" used OJOIN in "+parameters[0]);
  89                         // they're already in the channel
  90                         std::vector<std::string> modes;
  91                         modes.push_back(parameters[0]);
  92                         modes.push_back(op ? "+Yo" : "+Y");
  93                         modes.push_back(user->nick);
  94                         if (op)
  95                                 modes.push_back(user->nick);
  96                         ServerInstance->SendGlobalMode(modes, ServerInstance->FakeClient);
  97                 }
  98                 return CMD_SUCCESS;
  99         }
 100 };
 101
 102 /** channel mode +Y
 103  */
 104 class NetworkPrefix : public ModeHandler
 105 {
 106  public:
 107         NetworkPrefix(Module* parent) : ModeHandler(parent, "official-join", 'Y', PARAM_ALWAYS, MODETYPE_CHANNEL)
 108         {
 109                 list = true;
 110                 prefix = NPrefix;
 111                 levelrequired = INT_MAX;
 112                 m_paramtype = TR_NICK;
 113                 prefixrank = NETWORK_VALUE;
 114         }
 115
 116         ModResult AccessCheck(User* source, Channel* channel, std::string &parameter, bool adding)
 117         {
 118                 User* theuser = ServerInstance->FindNick(parameter);
 119                 // remove own privs?
 120                 if (source == theuser && !adding)
 121                         return MOD_RES_ALLOW;
 122
 123                 return MOD_RES_PASSTHRU;
 124         }
 125
 126         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
 127         {
 128                 return MODEACTION_ALLOW;
 129         }
 130
 131 };
 132
 133 class ModuleOjoin : public Module
 134 {
 135         NetworkPrefix* np;
 136         CommandOjoin mycommand;
 137
 138  public:
 139
 140         ModuleOjoin()
 141                 : np(NULL), mycommand(this)
 142         {
 143         }
 144
 145         void init() CXX11_OVERRIDE
 146         {
 147                 /* Load config stuff */
 148                 OnRehash(NULL);
 149
 150                 /* Initialise module variables */
 151                 np = new NetworkPrefix(this);
 152
 153                 ServerInstance->Modules->AddService(*np);
 154                 ServerInstance->Modules->AddService(mycommand);
 155
 156                 Implementation eventlist[] = { I_OnUserPreJoin, I_OnUserPreKick, I_OnRehash };
 157                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 158         }
 159
 160         ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
 161         {
 162                 if (mycommand.active)
 163                 {
 164                         privs += 'Y';
 165                         if (op)
 166                                 privs += 'o';
 167                         return MOD_RES_ALLOW;
 168                 }
 169
 170                 return MOD_RES_PASSTHRU;
 171         }
 172
 173         void OnRehash(User* user) CXX11_OVERRIDE
 174         {
 175                 ConfigTag* Conf = ServerInstance->Config->ConfValue("ojoin");
 176
 177                 if (!np)
 178                 {
 179                         // This is done on module load only
 180                         std::string npre = Conf->getString("prefix");
 181                         NPrefix = npre.empty() ? 0 : npre[0];
 182
 183                         if (NPrefix && ServerInstance->Modes->FindPrefix(NPrefix))
 184                                 throw ModuleException("Looks like the +Y prefix you picked for m_ojoin is already in use. Pick another.");
 185                 }
 186
 187                 notice = Conf->getBool("notice", true);
 188                 op = Conf->getBool("op", true);
 189         }
 190
 191         ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason) CXX11_OVERRIDE
 192         {
 193                 // Don't do anything if they're not +Y
 194                 if (!memb->hasMode('Y'))
 195                         return MOD_RES_PASSTHRU;
 196
 197                 // Let them do whatever they want to themselves.
 198                 if (source == memb->user)
 199                         return MOD_RES_PASSTHRU;
 200
 201                 source->WriteNumeric(484, source->nick+" "+memb->chan->name+" :Can't kick "+memb->user->nick+" as they're on official network business.");
 202                 return MOD_RES_DENY;
 203         }
 204
 205         ~ModuleOjoin()
 206         {
 207                 delete np;
 208         }
 209
 210         void Prioritize()
 211         {
 212                 ServerInstance->Modules->SetPriority(this, I_OnUserPreJoin, PRIORITY_FIRST);
 213         }
 214
 215         Version GetVersion() CXX11_OVERRIDE
 216         {
 217                 return Version("Network Business Join", VF_VENDOR);
 218         }
 219 };
 220
 221 MODULE_INIT(ModuleOjoin)