src/modules/m_services_account.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2012 Shawn Smith <shawn@inspircd.org>
   5  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   6  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   7  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
   8  *   Copyright (C) 2006, 2008 Craig Edwards <craigedwards@brainbox.cc>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 /* $ModDesc: Provides support for ircu-style services accounts, including chmode +R, etc. */
  26
  27 #include "inspircd.h"
  28 #include "modules/account.h"
  29
  30 /** Channel mode +r - mark a channel as identified
  31  */
  32 class Channel_r : public ModeHandler
  33 {
  34  public:
  35         Channel_r(Module* Creator) : ModeHandler(Creator, "c_registered", 'r', PARAM_NONE, MODETYPE_CHANNEL) { }
  36
  37         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
  38         {
  39                 // only a u-lined server may add or remove the +r mode.
  40                 if (!IS_LOCAL(source))
  41                 {
  42                         // Only change the mode if it's not redundant
  43                         if ((adding != channel->IsModeSet('r')))
  44                         {
  45                                 channel->SetMode('r',adding);
  46                                 return MODEACTION_ALLOW;
  47                         }
  48                 }
  49                 else
  50                 {
  51                         source->WriteNumeric(500, "%s :Only a server may modify the +r channel mode", source->nick.c_str());
  52                 }
  53                 return MODEACTION_DENY;
  54         }
  55 };
  56
  57 /** User mode +r - mark a user as identified
  58  */
  59 class User_r : public ModeHandler
  60 {
  61
  62  public:
  63         User_r(Module* Creator) : ModeHandler(Creator, "u_registered", 'r', PARAM_NONE, MODETYPE_USER) { }
  64
  65         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
  66         {
  67                 if (!IS_LOCAL(source))
  68                 {
  69                         if ((adding != dest->IsModeSet('r')))
  70                         {
  71                                 dest->SetMode('r',adding);
  72                                 return MODEACTION_ALLOW;
  73                         }
  74                 }
  75                 else
  76                 {
  77                         source->WriteNumeric(500, "%s :Only a server may modify the +r user mode", source->nick.c_str());
  78                 }
  79                 return MODEACTION_DENY;
  80         }
  81 };
  82
  83 /** Channel mode +R - unidentified users cannot join
  84  */
  85 class AChannel_R : public SimpleChannelModeHandler
  86 {
  87  public:
  88         AChannel_R(Module* Creator) : SimpleChannelModeHandler(Creator, "reginvite", 'R') { }
  89 };
  90
  91 /** User mode +R - unidentified users cannot message
  92  */
  93 class AUser_R : public SimpleUserModeHandler
  94 {
  95  public:
  96         AUser_R(Module* Creator) : SimpleUserModeHandler(Creator, "regdeaf", 'R') { }
  97 };
  98
  99 /** Channel mode +M - unidentified users cannot message channel
 100  */
 101 class AChannel_M : public SimpleChannelModeHandler
 102 {
 103  public:
 104         AChannel_M(Module* Creator) : SimpleChannelModeHandler(Creator, "regmoderated", 'M') { }
 105 };
 106
 107 class ModuleServicesAccount : public Module
 108 {
 109         AChannel_R m1;
 110         AChannel_M m2;
 111         AUser_R m3;
 112         Channel_r m4;
 113         User_r m5;
 114         AccountExtItem accountname;
 115  public:
 116         ModuleServicesAccount() : m1(this), m2(this), m3(this), m4(this), m5(this),
 117                 accountname("accountname", this)
 118         {
 119         }
 120
 121         void init() CXX11_OVERRIDE
 122         {
 123                 ServiceProvider* providerlist[] = { &m1, &m2, &m3, &m4, &m5, &accountname };
 124                 ServerInstance->Modules->AddServices(providerlist, sizeof(providerlist)/sizeof(ServiceProvider*));
 125                 Implementation eventlist[] = { I_OnWhois, I_OnUserPreMessage, I_OnUserPreJoin, I_OnCheckBan,
 126                         I_OnDecodeMetaData, I_On005Numeric, I_OnUserPostNick, I_OnSetConnectClass };
 127
 128                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 129         }
 130
 131         void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
 132         {
 133                 tokens["EXTBAN"].push_back('R');
 134                 tokens["EXTBAN"].push_back('U');
 135         }
 136
 137         /* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
 138         void OnWhois(User* source, User* dest) CXX11_OVERRIDE
 139         {
 140                 std::string *account = accountname.get(dest);
 141
 142                 if (account)
 143                 {
 144                         ServerInstance->SendWhoisLine(source, dest, 330, "%s %s %s :is logged in as", source->nick.c_str(), dest->nick.c_str(), account->c_str());
 145                 }
 146
 147                 if (dest->IsModeSet('r'))
 148                 {
 149                         /* user is registered */
 150                         ServerInstance->SendWhoisLine(source, dest, 307, "%s %s :is a registered nick", source->nick.c_str(), dest->nick.c_str());
 151                 }
 152         }
 153
 154         void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE
 155         {
 156                 /* On nickchange, if they have +r, remove it */
 157                 if (user->IsModeSet('r') && assign(user->nick) != oldnick)
 158                 {
 159                         std::vector<std::string> modechange;
 160                         modechange.push_back(user->nick);
 161                         modechange.push_back("-r");
 162                         ServerInstance->SendMode(modechange, ServerInstance->FakeClient);
 163                 }
 164         }
 165
 166         ModResult OnUserPreMessage(User* user, void* dest, int target_type, std::string& text, char status, CUList& exempt_list, MessageType msgtype) CXX11_OVERRIDE
 167         {
 168                 if (!IS_LOCAL(user))
 169                         return MOD_RES_PASSTHRU;
 170
 171                 std::string *account = accountname.get(user);
 172                 bool is_registered = account && !account->empty();
 173
 174                 if (target_type == TYPE_CHANNEL)
 175                 {
 176                         Channel* c = (Channel*)dest;
 177                         ModResult res = ServerInstance->OnCheckExemption(user,c,"regmoderated");
 178
 179                         if (c->IsModeSet('M') && !is_registered && res != MOD_RES_ALLOW)
 180                         {
 181                                 // user messaging a +M channel and is not registered
 182                                 user->WriteNumeric(477, user->nick+" "+c->name+" :You need to be identified to a registered account to message this channel");
 183                                 return MOD_RES_DENY;
 184                         }
 185                 }
 186                 else if (target_type == TYPE_USER)
 187                 {
 188                         User* u = (User*)dest;
 189
 190                         if (u->IsModeSet('R') && !is_registered)
 191                         {
 192                                 // user messaging a +R user and is not registered
 193                                 user->WriteNumeric(477, ""+ user->nick +" "+ u->nick +" :You need to be identified to a registered account to message this user");
 194                                 return MOD_RES_DENY;
 195                         }
 196                 }
 197                 return MOD_RES_PASSTHRU;
 198         }
 199
 200         ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
 201         {
 202                 static bool checking = false;
 203                 if (checking)
 204                         return MOD_RES_PASSTHRU;
 205
 206                 if ((mask.length() > 2) && (mask[1] == ':'))
 207                 {
 208                         if (mask[0] == 'R')
 209                         {
 210                                 std::string *account = accountname.get(user);
 211                                 if (account && InspIRCd::Match(*account, mask.substr(2)))
 212                                         return MOD_RES_DENY;
 213                         }
 214                         else if (mask[0] == 'U')
 215                         {
 216                                 std::string *account = accountname.get(user);
 217                                 /* If the user is registered we don't care. */
 218                                 if (account)
 219                                         return MOD_RES_PASSTHRU;
 220
 221                                 /* If we made it this far we know the user isn't registered
 222                                         so just deny if it matches */
 223                                 checking = true;
 224                                 bool result = chan->CheckBan(user, mask.substr(2));
 225                                 checking = false;
 226
 227                                 if (result)
 228                                         return MOD_RES_DENY;
 229                         }
 230                 }
 231
 232                 /* If we made it this far then the ban wasn't an ExtBan
 233                         or the user we were checking for didn't match either ExtBan */
 234                 return MOD_RES_PASSTHRU;
 235         }
 236
 237         ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
 238         {
 239                 std::string *account = accountname.get(user);
 240                 bool is_registered = account && !account->empty();
 241
 242                 if (chan)
 243                 {
 244                         if (chan->IsModeSet('R'))
 245                         {
 246                                 if (!is_registered)
 247                                 {
 248                                         // joining a +R channel and not identified
 249                                         user->WriteNumeric(477, user->nick + " " + chan->name + " :You need to be identified to a registered account to join this channel");
 250                                         return MOD_RES_DENY;
 251                                 }
 252                         }
 253                 }
 254                 return MOD_RES_PASSTHRU;
 255         }
 256
 257         // Whenever the linking module receives metadata from another server and doesnt know what
 258         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 259         // module in turn to figure out if this metadata key belongs to them, and what they want
 260         // to do with it.
 261         // In our case we're only sending a single string around, so we just construct a std::string.
 262         // Some modules will probably get much more complex and format more detailed structs and classes
 263         // in a textual way for sending over the link.
 264         void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata) CXX11_OVERRIDE
 265         {
 266                 User* dest = dynamic_cast<User*>(target);
 267                 // check if its our metadata key, and its associated with a user
 268                 if (dest && (extname == "accountname"))
 269                 {
 270                         std::string *account = accountname.get(dest);
 271                         if (account && !account->empty())
 272                         {
 273                                 trim(*account);
 274
 275                                 if (IS_LOCAL(dest))
 276                                         dest->WriteNumeric(900, "%s %s %s :You are now logged in as %s",
 277                                                 dest->nick.c_str(), dest->GetFullHost().c_str(), account->c_str(), account->c_str());
 278
 279                                 AccountEvent(this, dest, *account).Send();
 280                         }
 281                         else
 282                         {
 283                                 AccountEvent(this, dest, "").Send();
 284                         }
 285                 }
 286         }
 287
 288         ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
 289         {
 290                 if (myclass->config->getBool("requireaccount") && !accountname.get(user))
 291                         return MOD_RES_DENY;
 292                 return MOD_RES_PASSTHRU;
 293         }
 294
 295         Version GetVersion() CXX11_OVERRIDE
 296         {
 297                 return Version("Provides support for ircu-style services accounts, including chmode +R, etc.",VF_OPTCOMMON|VF_VENDOR);
 298         }
 299 };
 300
 301 MODULE_INIT(ModuleServicesAccount)
 302