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 "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) || ServerInstance->ULine(source->server))
  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) || ServerInstance->ULine(source->server))
  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()
 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_OnUserPreNotice, 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)
 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)
 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)
 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)
 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 ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
 175                 {
 176                         // user is ulined, can speak regardless
 177                         return MOD_RES_PASSTHRU;
 178                 }
 179
 180                 if (target_type == TYPE_CHANNEL)
 181                 {
 182                         Channel* c = (Channel*)dest;
 183                         ModResult res = ServerInstance->OnCheckExemption(user,c,"regmoderated");
 184
 185                         if (c->IsModeSet('M') && !is_registered && res != MOD_RES_ALLOW)
 186                         {
 187                                 // user messaging a +M channel and is not registered
 188                                 user->WriteNumeric(477, user->nick+" "+c->name+" :You need to be identified to a registered account to message this channel");
 189                                 return MOD_RES_DENY;
 190                         }
 191                 }
 192                 else if (target_type == TYPE_USER)
 193                 {
 194                         User* u = (User*)dest;
 195
 196                         if (u->IsModeSet('R') && !is_registered)
 197                         {
 198                                 // user messaging a +R user and is not registered
 199                                 user->WriteNumeric(477, ""+ user->nick +" "+ u->nick +" :You need to be identified to a registered account to message this user");
 200                                 return MOD_RES_DENY;
 201                         }
 202                 }
 203                 return MOD_RES_PASSTHRU;
 204         }
 205
 206         ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask)
 207         {
 208                 static bool checking = false;
 209                 if (checking)
 210                         return MOD_RES_PASSTHRU;
 211
 212                 if ((mask.length() > 2) && (mask[1] == ':'))
 213                 {
 214                         if (mask[0] == 'R')
 215                         {
 216                                 std::string *account = accountname.get(user);
 217                                 if (account && InspIRCd::Match(*account, mask.substr(2)))
 218                                         return MOD_RES_DENY;
 219                         }
 220                         else if (mask[0] == 'U')
 221                         {
 222                                 std::string *account = accountname.get(user);
 223                                 /* If the user is registered we don't care. */
 224                                 if (account)
 225                                         return MOD_RES_PASSTHRU;
 226
 227                                 /* If we made it this far we know the user isn't registered
 228                                         so just deny if it matches */
 229                                 checking = true;
 230                                 bool result = chan->CheckBan(user, mask.substr(2));
 231                                 checking = false;
 232
 233                                 if (result)
 234                                         return MOD_RES_DENY;
 235                         }
 236                 }
 237
 238                 /* If we made it this far then the ban wasn't an ExtBan
 239                         or the user we were checking for didn't match either ExtBan */
 240                 return MOD_RES_PASSTHRU;
 241         }
 242
 243         ModResult OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 244         {
 245                 return OnUserPreMessage(user, dest, target_type, text, status, exempt_list);
 246         }
 247
 248         ModResult OnUserPreJoin(User* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven)
 249         {
 250                 if (!IS_LOCAL(user))
 251                         return MOD_RES_PASSTHRU;
 252
 253                 std::string *account = accountname.get(user);
 254                 bool is_registered = account && !account->empty();
 255
 256                 if (chan)
 257                 {
 258                         if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
 259                         {
 260                                 // user is ulined, won't be stopped from joining
 261                                 return MOD_RES_PASSTHRU;
 262                         }
 263
 264                         if (chan->IsModeSet('R'))
 265                         {
 266                                 if (!is_registered)
 267                                 {
 268                                         // joining a +R channel and not identified
 269                                         user->WriteNumeric(477, user->nick + " " + chan->name + " :You need to be identified to a registered account to join this channel");
 270                                         return MOD_RES_DENY;
 271                                 }
 272                         }
 273                 }
 274                 return MOD_RES_PASSTHRU;
 275         }
 276
 277         // Whenever the linking module receives metadata from another server and doesnt know what
 278         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 279         // module in turn to figure out if this metadata key belongs to them, and what they want
 280         // to do with it.
 281         // In our case we're only sending a single string around, so we just construct a std::string.
 282         // Some modules will probably get much more complex and format more detailed structs and classes
 283         // in a textual way for sending over the link.
 284         void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata)
 285         {
 286                 User* dest = dynamic_cast<User*>(target);
 287                 // check if its our metadata key, and its associated with a user
 288                 if (dest && (extname == "accountname"))
 289                 {
 290                         std::string *account = accountname.get(dest);
 291                         if (account && !account->empty())
 292                         {
 293                                 trim(*account);
 294
 295                                 if (IS_LOCAL(dest))
 296                                         dest->WriteNumeric(900, "%s %s %s :You are now logged in as %s",
 297                                                 dest->nick.c_str(), dest->GetFullHost().c_str(), account->c_str(), account->c_str());
 298
 299                                 AccountEvent(this, dest, *account).Send();
 300                         }
 301                         else
 302                         {
 303                                 AccountEvent(this, dest, "").Send();
 304                         }
 305                 }
 306         }
 307
 308         ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass)
 309         {
 310                 if (myclass->config->getBool("requireaccount") && !accountname.get(user))
 311                         return MOD_RES_DENY;
 312                 return MOD_RES_PASSTHRU;
 313         }
 314
 315         Version GetVersion()
 316         {
 317                 return Version("Provides support for ircu-style services accounts, including chmode +R, etc.",VF_OPTCOMMON|VF_VENDOR);
 318         }
 319 };
 320
 321 MODULE_INIT(ModuleServicesAccount)
 322