src/modules/m_services_account.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 using namespace std;
  18
  19 #include <stdio.h>
  20 #include "users.h"
  21 #include "channels.h"
  22 #include "modules.h"
  23 #include <string>
  24 #include "helperfuncs.h"
  25 #include "hashcomp.h"
  26
  27 /* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
  28
  29 class AChannel_R : public ModeHandler
  30 {
  31  public:
  32         AChannel_R() : ModeHandler('R', 0, 0, false, MODETYPE_CHANNEL, false) { }
  33
  34         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
  35         {
  36                 if (adding)
  37                 {
  38                         if (!channel->IsModeSet('R'))
  39                         {
  40                                 channel->SetMode('R',true);
  41                                 return MODEACTION_ALLOW;
  42                         }
  43                 }
  44                 else
  45                 {
  46                         if (channel->IsModeSet('R'))
  47                         {
  48                                 channel->SetMode('R',false);
  49                                 return MODEACTION_ALLOW;
  50                         }
  51                 }
  52
  53                 return MODEACTION_DENY;
  54         }
  55 };
  56
  57 class AUser_R : public ModeHandler
  58 {
  59  public:
  60         AUser_R() : ModeHandler('R', 0, 0, false, MODETYPE_USER, false) { }
  61
  62         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
  63         {
  64                 if (adding)
  65                 {
  66                         if (!dest->IsModeSet('R'))
  67                         {
  68                                 dest->SetMode('R',true);
  69                                 return MODEACTION_ALLOW;
  70                         }
  71                 }
  72                 else
  73                 {
  74                         if (dest->IsModeSet('R'))
  75                         {
  76                                 dest->SetMode('R',false);
  77                                 return MODEACTION_ALLOW;
  78                         }
  79                 }
  80
  81                 return MODEACTION_DENY;
  82         }
  83 };
  84
  85 class AChannel_M : public ModeHandler
  86 {
  87  public:
  88         AChannel_M() : ModeHandler('M', 0, 0, false, MODETYPE_CHANNEL, false) { }
  89
  90         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
  91         {
  92                 if (adding)
  93                 {
  94                         if (!channel->IsModeSet('M'))
  95                         {
  96                                 channel->SetMode('M',true);
  97                                 return MODEACTION_ALLOW;
  98                         }
  99                 }
 100                 else
 101                 {
 102                         if (channel->IsModeSet('M'))
 103                         {
 104                                 channel->SetMode('M',true);
 105                                 return MODEACTION_ALLOW;
 106                         }
 107                 }
 108
 109                 return MODEACTION_DENY;
 110         }
 111 };
 112
 113 class ModuleServicesAccount : public Module
 114 {
 115         Server *Srv;
 116         AChannel_R* m1;
 117         AChannel_M* m2;
 118         AUser_R* m3;
 119  public:
 120         ModuleServicesAccount(Server* Me) : Module::Module(Me)
 121         {
 122                 Srv = Me;
 123                 m1 = new AChannel_R();
 124                 m2 = new AChannel_M();
 125                 m3 = new AUser_R();
 126                 Srv->AddMode(m1, 'R');
 127                 Srv->AddMode(m2, 'M');
 128                 Srv->AddMode(m3, 'R');
 129         }
 130
 131         virtual void On005Numeric(std::string &output)
 132         {
 133                 InsertMode(output, "RM", 4);
 134         }
 135
 136         /* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
 137         virtual void OnWhois(userrec* source, userrec* dest)
 138         {
 139                 char *account = dest->GetExt("accountname");
 140
 141                 if (account)
 142                 {
 143                         std::string* accountn = (std::string*)account;
 144                         WriteServ(source->fd, "330 %s %s %s :is logged in as", source->nick, dest->nick, accountn->c_str());
 145                 }
 146         }
 147
 148         void Implements(char* List)
 149         {
 150                 List[I_OnWhois] = List[I_OnUserPreMessage] = List[I_On005Numeric] = List[I_OnUserPreNotice] = List[I_OnUserPreJoin] = 1;
 151                 List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnDecodeMetaData] = 1;
 152         }
 153
 154         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status)
 155         {
 156                 char *account = user->GetExt("accountname");
 157
 158                 if (target_type == TYPE_CHANNEL)
 159                 {
 160                         chanrec* c = (chanrec*)dest;
 161
 162                         if ((c->IsModeSet('M')) && (!account))
 163                         {
 164                                 if ((Srv->IsUlined(user->nick)) || (Srv->IsUlined(user->server)) || (!strcmp(user->server,"")))
 165                                 {
 166                                         // user is ulined, can speak regardless
 167                                         return 0;
 168                                 }
 169
 170                                 // user messaging a +M channel and is not registered
 171                                 Srv->SendServ(user->fd,"477 "+std::string(user->nick)+" "+std::string(c->name)+" :You need to be identified to a registered account to message this channel");
 172                                 return 1;
 173                         }
 174                 }
 175                 if (target_type == TYPE_USER)
 176                 {
 177                         userrec* u = (userrec*)dest;
 178
 179                         if ((u->modes['R'-65]) && (!account))
 180                         {
 181                                 if ((Srv->IsUlined(user->nick)) || (Srv->IsUlined(user->server)))
 182                                 {
 183                                         // user is ulined, can speak regardless
 184                                         return 0;
 185                                 }
 186
 187                                 // user messaging a +R user and is not registered
 188                                 Srv->SendServ(user->fd,"477 "+std::string(user->nick)+" "+std::string(u->nick)+" :You need to be identified to a registered account to message this user");
 189                                 return 1;
 190                         }
 191                 }
 192                 return 0;
 193         }
 194
 195         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status)
 196         {
 197                 return OnUserPreMessage(user, dest, target_type, text, status);
 198         }
 199
 200         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname)
 201         {
 202                 char *account = user->GetExt("accountname");
 203
 204                 if (chan)
 205                 {
 206                         if (chan->IsModeSet('R'))
 207                         {
 208                                 if (!account)
 209                                 {
 210                                         if ((Srv->IsUlined(user->nick)) || (Srv->IsUlined(user->server)))
 211                                         {
 212                                                 // user is ulined, won't be stopped from joining
 213                                                 return 0;
 214                                         }
 215                                         // joining a +R channel and not identified
 216                                         Srv->SendServ(user->fd,"477 "+std::string(user->nick)+" "+std::string(chan->name)+" :You need to be identified to a registered account to join this channel");
 217                                         return 1;
 218                                 }
 219                         }
 220                 }
 221                 return 0;
 222         }
 223
 224         // Whenever the linking module wants to send out data, but doesnt know what the data
 225         // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
 226         // this method is called. We should use the ProtoSendMetaData function after we've
 227         // corrected decided how the data should look, to send the metadata on its way if
 228         // it is ours.
 229         virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
 230         {
 231                 // check if the linking module wants to know about OUR metadata
 232                 if (extname == "accountname")
 233                 {
 234                         // check if this user has an swhois field to send
 235                         char* field = user->GetExt("accountname");
 236                         if (field)
 237                         {
 238                                 // get our extdata out with a cast
 239                                 std::string* account = (std::string*)field;
 240                                 // call this function in the linking module, let it format the data how it
 241                                 // sees fit, and send it on its way. We dont need or want to know how.
 242                                 proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*account);
 243                         }
 244                 }
 245         }
 246
 247         // when a user quits, tidy up their metadata
 248         virtual void OnUserQuit(userrec* user, const std::string &message)
 249         {
 250                 char* field = user->GetExt("accountname");
 251                 if (field)
 252                 {
 253                         std::string* account = (std::string*)field;
 254                         user->Shrink("accountname");
 255                         delete account;
 256                 }
 257         }
 258
 259         // if the module is unloaded, tidy up all our dangling metadata
 260         virtual void OnCleanup(int target_type, void* item)
 261         {
 262                 if (target_type == TYPE_USER)
 263                 {
 264                         userrec* user = (userrec*)item;
 265                         char* field = user->GetExt("accountname");
 266                         if (field)
 267                         {
 268                                 std::string* account = (std::string*)field;
 269                                 user->Shrink("accountname");
 270                                 delete account;
 271                         }
 272                 }
 273         }
 274
 275         // Whenever the linking module receives metadata from another server and doesnt know what
 276         // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
 277         // module in turn to figure out if this metadata key belongs to them, and what they want
 278         // to do with it.
 279         // In our case we're only sending a single string around, so we just construct a std::string.
 280         // Some modules will probably get much more complex and format more detailed structs and classes
 281         // in a textual way for sending over the link.
 282         virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
 283         {
 284                 // check if its our metadata key, and its associated with a user
 285                 if ((target_type == TYPE_USER) && (extname == "accountname"))
 286                 {
 287                         userrec* dest = (userrec*)target;
 288                         /* logging them out? */
 289                         if (extdata == "")
 290                         {
 291                                 char* field = dest->GetExt("accountname");
 292                                 if (field)
 293                                 {
 294                                         std::string* account = (std::string*)field;
 295                                         dest->Shrink("accountname");
 296                                         delete account;
 297                                 }
 298                         }
 299                         else
 300                         {
 301                                 // if they dont already have an accountname field, accept the remote server's
 302                                 if (!dest->GetExt("accountname"))
 303                                 {
 304                                         std::string* text = new std::string(extdata);
 305                                         dest->Extend("accountname",(char*)text);
 306                                 }
 307                         }
 308                 }
 309         }
 310
 311         virtual ~ModuleServicesAccount()
 312         {
 313                 DELETE(m1);
 314                 DELETE(m2);
 315                 DELETE(m3);
 316         }
 317
 318         virtual Version GetVersion()
 319         {
 320                 return Version(1,0,0,0,VF_STATIC|VF_VENDOR);
 321         }
 322 };
 323
 324
 325 class ModuleServicesAccountFactory : public ModuleFactory
 326 {
 327  public:
 328         ModuleServicesAccountFactory()
 329         {
 330         }
 331
 332         ~ModuleServicesAccountFactory()
 333         {
 334         }
 335
 336         virtual Module * CreateModule(Server* Me)
 337         {
 338                 return new ModuleServicesAccount(Me);
 339         }
 340
 341 };
 342
 343
 344 extern "C" void * init_module( void )
 345 {
 346         return new ModuleServicesAccountFactory;
 347 }