src/modules/m_services_account.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #include "inspircd.h"
  15 #include "account.h"
  16
  17 /* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
  18
  19 /** Channel mode +r - mark a channel as identified
  20  */
  21 class Channel_r : public ModeHandler
  22 {
  23
  24  public:
  25         Channel_r(InspIRCd* Instance) : ModeHandler(Instance, 'r', 0, 0, false, MODETYPE_CHANNEL, false) { }
  26
  27         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
  28         {
  29                 // only a u-lined server may add or remove the +r mode.
  30                 if (IS_REMOTE(source) || ServerInstance->ULine(source->nick.c_str()) || ServerInstance->ULine(source->server))
  31                 {
  32                         // Only change the mode if it's not redundant
  33                         if ((adding && !channel->IsModeSet('r')) || (!adding && channel->IsModeSet('r')))
  34                         {
  35                                 channel->SetMode('r',adding);
  36                                 return MODEACTION_ALLOW;
  37                         }
  38
  39                         return MODEACTION_DENY;
  40                 }
  41                 else
  42                 {
  43                         source->WriteNumeric(500, "%s :Only a server may modify the +r channel mode", source->nick.c_str());
  44                         return MODEACTION_DENY;
  45                 }
  46         }
  47 };
  48
  49 /** User mode +r - mark a user as identified
  50  */
  51 class User_r : public ModeHandler
  52 {
  53
  54  public:
  55         User_r(InspIRCd* Instance) : ModeHandler(Instance, 'r', 0, 0, false, MODETYPE_USER, false) { }
  56
  57         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode)
  58         {
  59                 if (servermode || IS_REMOTE(source) || ServerInstance->ULine(source->nick.c_str()) || ServerInstance->ULine(source->server))
  60                 {
  61                         if ((adding && !dest->IsModeSet('r')) || (!adding && dest->IsModeSet('r')))
  62                         {
  63                                 dest->SetMode('r',adding);
  64                                 return MODEACTION_ALLOW;
  65                         }
  66                         return MODEACTION_DENY;
  67                 }
  68                 else
  69                 {
  70                         source->WriteNumeric(500, "%s :Only a server may modify the +r user mode", source->nick.c_str());
  71                         return MODEACTION_DENY;
  72                 }
  73         }
  74 };
  75
  76 /** Channel mode +R - unidentified users cannot join
  77  */
  78 class AChannel_R : public SimpleChannelModeHandler
  79 {
  80  public:
  81         AChannel_R(InspIRCd* Instance) : SimpleChannelModeHandler(Instance, 'R') { }
  82 };
  83
  84 /** User mode +R - unidentified users cannot message
  85  */
  86 class AUser_R : public SimpleUserModeHandler
  87 {
  88  public:
  89         AUser_R(InspIRCd* Instance) : SimpleUserModeHandler(Instance, 'R') { }
  90 };
  91
  92 /** Channel mode +M - unidentified users cannot message channel
  93  */
  94 class AChannel_M : public SimpleChannelModeHandler
  95 {
  96  public:
  97         AChannel_M(InspIRCd* Instance) : SimpleChannelModeHandler(Instance, 'M') { }
  98 };
  99
 100 class ModuleServicesAccount : public Module
 101 {
 102         AChannel_R m1;
 103         AChannel_M m2;
 104         AUser_R m3;
 105         Channel_r m4;
 106         User_r m5;
 107  public:
 108         ModuleServicesAccount(InspIRCd* Me) : Module(Me),
 109                 m1(Me), m2(Me), m3(Me), m4(Me), m5(Me)
 110         {
 111
 112                 if (!ServerInstance->Modes->AddMode(&m1) || !ServerInstance->Modes->AddMode(&m2) ||
 113                         !ServerInstance->Modes->AddMode(&m3) || !ServerInstance->Modes->AddMode(&m4) ||
 114                         !ServerInstance->Modes->AddMode(&m5))
 115                         throw ModuleException("Some other module has claimed our modes!");
 116
 117                 Implementation eventlist[] = { I_OnWhois, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreJoin, I_OnCheckBan,
 118                         I_OnSyncUserMetaData, I_OnUserQuit, I_OnCleanup, I_OnDecodeMetaData, I_On005Numeric, I_OnUserPostNick };
 119
 120                 ServerInstance->Modules->Attach(eventlist, this, 10);
 121         }
 122
 123         virtual void On005Numeric(std::string &t)
 124         {
 125                 ServerInstance->AddExtBanChar('R');
 126                 ServerInstance->AddExtBanChar('M');
 127         }
 128
 129         /* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
 130         virtual void OnWhois(User* source, User* dest)
 131         {
 132                 std::string *account;
 133                 dest->GetExt("accountname", account);
 134
 135                 if (account)
 136                 {
 137                         ServerInstance->SendWhoisLine(source, dest, 330, "%s %s %s :is logged in as", source->nick.c_str(), dest->nick.c_str(), account->c_str());
 138                 }
 139
 140                 if (dest->IsModeSet('r'))
 141                 {
 142                         /* user is registered */
 143                         ServerInstance->SendWhoisLine(source, dest, 307, "%s %s :is a registered nick", source->nick.c_str(), dest->nick.c_str());
 144                 }
 145         }
 146
 147         virtual void OnUserPostNick(User* user, const std::string &oldnick)
 148         {
 149                 /* On nickchange, if they have +r, remove it */
 150                 if (user->IsModeSet('r') && assign(user->nick) != oldnick)
 151                 {
 152                         std::vector<std::string> modechange;
 153                         modechange.push_back(user->nick);
 154                         modechange.push_back("-r");
 155                         ServerInstance->SendMode(modechange, user);
 156                 }
 157         }
 158
 159         virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 160         {
 161                 if (!IS_LOCAL(user))
 162                         return 0;
 163
 164                 std::string *account;
 165                 bool is_registered = user->GetExt("accountname", account);
 166                 is_registered = is_registered && !account->empty();
 167
 168                 if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
 169                 {
 170                         // user is ulined, can speak regardless
 171                         return 0;
 172                 }
 173
 174                 if (target_type == TYPE_CHANNEL)
 175                 {
 176                         Channel* c = (Channel*)dest;
 177
 178                         if (c->IsModeSet('M') && !is_registered)
 179                         {
 180                                 // user messaging a +M channel and is not registered
 181                                 user->WriteNumeric(477, ""+std::string(user->nick)+" "+std::string(c->name)+" :You need to be identified to a registered account to message this channel");
 182                                 return 1;
 183                         }
 184
 185                         if (account)
 186                         {
 187                                 if (c->GetExtBanStatus(*account, 'M') < 0)
 188                                 {
 189                                         // may not speak (text is deliberately vague, so they don't know which restriction to evade)
 190                                         user->WriteNumeric(477, ""+std::string(user->nick)+" "+std::string(c->name)+" :You may not speak in this channel");
 191                                         return 1;
 192                                 }
 193                         }
 194                 }
 195                 else if (target_type == TYPE_USER)
 196                 {
 197                         User* u = (User*)dest;
 198
 199                         if (u->IsModeSet('R') && !is_registered)
 200                         {
 201                                 // user messaging a +R user and is not registered
 202                                 user->WriteNumeric(477, ""+ user->nick +" "+ u->nick +" :You need to be identified to a registered account to message this user");
 203                                 return 1;
 204                         }
 205                 }
 206                 return 0;
 207         }
 208
 209         virtual int OnCheckBan(User* user, Channel* chan)
 210         {
 211                 std::string* account;
 212                 if (!user->GetExt("accountname", account))
 213                         return 0;
 214                 return chan->GetExtBanStatus(*account, 'R');
 215         }
 216
 217         virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 218         {
 219                 return OnUserPreMessage(user, dest, target_type, text, status, exempt_list);
 220         }
 221
 222         virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven)
 223         {
 224                 if (!IS_LOCAL(user))
 225                         return 0;
 226
 227                 std::string *account;
 228                 bool is_registered = user->GetExt("accountname", account);
 229                 is_registered = is_registered && !account->empty();
 230
 231                 if (chan)
 232                 {
 233                         if ((ServerInstance->ULine(user->nick.c_str())) || (ServerInstance->ULine(user->server)))
 234                         {
 235                                 // user is ulined, won't be stopped from joining
 236                                 return 0;
 237                         }
 238
 239                         if (chan->IsModeSet('R'))
 240                         {
 241                                 if (!is_registered)
 242                                 {
 243                                         // joining a +R channel and not identified
 244                                         user->WriteNumeric(477, user->nick + " " + chan->name + " :You need to be identified to a registered account to join this channel");
 245                                         return 1;
 246                                 }
 247                         }
 248                 }
 249                 return 0;
 250         }
 251
 252         // Whenever the linking module wants to send out data, but doesnt know what the data
 253         // represents (e.g. it is metadata, added to a User or Channel by a module) then
 254         // this method is called. We should use the ProtoSendMetaData function after we've
 255         // corrected decided how the data should look, to send the metadata on its way if
 256         // it is ours.
 257         virtual void OnSyncUserMetaData(User* user, Module* proto, void* opaque, const std::string &extname, bool displayable)
 258         {
 259                 // check if the linking module wants to know about OUR metadata
 260                 if (extname == "accountname")
 261                 {
 262                         // check if this user has an swhois field to send
 263                         std::string* account;
 264                         user->GetExt("accountname", account);
 265                         if (account)
 266                         {
 267                                 // remove any accidental leading/trailing spaces
 268                                 trim(*account);
 269
 270                                 // call this function in the linking module, let it format the data how it
 271                                 // sees fit, and send it on its way. We dont need or want to know how.
 272                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*account);
 273                         }
 274                 }
 275         }
 276
 277         // when a user quits, tidy up their metadata
 278         virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message)
 279         {
 280                 std::string* account;
 281                 user->GetExt("accountname", account);
 282                 if (account)
 283                 {
 284                         user->Shrink("accountname");
 285                         delete account;
 286                 }
 287         }
 288
 289         // if the module is unloaded, tidy up all our dangling metadata
 290         virtual void OnCleanup(int target_type, void* item)
 291         {
 292                 if (target_type == TYPE_USER)
 293                 {
 294                         User* user = (User*)item;
 295                         std::string* account;
 296                         user->GetExt("accountname", account);
 297                         if (account)
 298                         {
 299                                 user->Shrink("accountname");
 300                                 delete account;
 301                         }
 302                 }
 303         }
 304
 305         // Whenever the linking module receives metadata from another server and doesnt know what
 306         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 307         // module in turn to figure out if this metadata key belongs to them, and what they want
 308         // to do with it.
 309         // In our case we're only sending a single string around, so we just construct a std::string.
 310         // Some modules will probably get much more complex and format more detailed structs and classes
 311         // in a textual way for sending over the link.
 312         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 313         {
 314                 // check if its our metadata key, and its associated with a user
 315                 if ((target_type == TYPE_USER) && (extname == "accountname"))
 316                 {
 317                         User* dest = (User*)target;
 318
 319                         std::string* account;
 320                         if (dest->GetExt("accountname", account)) {
 321                                 // remove old account so that we can set new (or leave unset)
 322                                 dest->Shrink("accountname");
 323                                 delete account;
 324                         }
 325
 326                         if (!extdata.empty())
 327                         {
 328                                 account = new std::string(extdata);
 329                                 // remove any accidental leading/trailing spaces
 330                                 trim(*account);
 331                                 dest->Extend("accountname", account);
 332
 333                                 if (IS_LOCAL(dest))
 334                                         dest->WriteNumeric(900, "%s %s %s :You are now logged in as %s",
 335                                                 dest->nick.c_str(), dest->GetFullHost().c_str(), account->c_str(), account->c_str());
 336
 337                                 AccountData ac;
 338                                 ac.user = dest;
 339                                 ac.account = *account;
 340                                 Event n((char*)&ac, this, "account_login");
 341                                 n.Send(ServerInstance);
 342                         }
 343                 }
 344         }
 345
 346         virtual ~ModuleServicesAccount()
 347         {
 348                 ServerInstance->Modes->DelMode(&m1);
 349                 ServerInstance->Modes->DelMode(&m2);
 350                 ServerInstance->Modes->DelMode(&m3);
 351                 ServerInstance->Modes->DelMode(&m4);
 352                 ServerInstance->Modes->DelMode(&m5);
 353         }
 354
 355         virtual Version GetVersion()
 356         {
 357                 return Version("$Id$",VF_COMMON|VF_VENDOR,API_VERSION);
 358         }
 359 };
 360
 361 MODULE_INIT(ModuleServicesAccount)