src/modules/m_park.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  Inspire is copyright (C) 2002-2004 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 #include <stdio.h>
  18 #include <string>
  19 #include <vector>
  20 #include "users.h"
  21 #include "channels.h"
  22 #include "modules.h"
  23
  24 /* $ModDesc: Provides support for user parking/unparking */
  25
  26 class awaymsg
  27 {
  28  public:
  29         std::string from;
  30         std::string text;
  31         time_t tm;
  32 };
  33
  34 class parkedinfo
  35 {
  36  public:
  37         std::string nick;
  38         std::string host;
  39         time_t parktime;
  40 };
  41
  42 Server *Srv;
  43 typedef std::vector<awaymsg> awaylog;
  44 typedef std::vector<parkedinfo> parkinfo;
  45 parkinfo pinfo;
  46 long ParkMaxTime;
  47 long ConcurrentParks;
  48 long ParkMaxMsgs;
  49 parkedinfo pi;
  50
  51 void handle_park(char **parameters, int pcnt, userrec *user)
  52 {
  53         /** Parking. easy stuff.
  54          *
  55          * We duplicate and switch the users file descriptor, so that they can remain forever as a 'ghost'
  56          * We then disconnect the real user leaving a controlled ghost in their place :)
  57          */
  58         int othersessions = 0;
  59         if (pinfo.size())
  60                 for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
  61                         if (j->host == std::string(user->host))
  62                                 othersessions++;
  63         if (othersessions >= ConcurrentParks)
  64         {
  65                 Srv->SendServ(user->fd,"927 "+std::string(user->nick)+" :You are already parked up to the maximum number of allowed times.");
  66         }
  67         else
  68         {
  69                 awaylog* aw;
  70                 char msg[MAXBUF];
  71                 long key = abs(random() * 12345);
  72                 snprintf(msg,MAXBUF,"You are now parked. To unpark use /UNPARK %s %d",user->nick,key);
  73                 Srv->UserToPseudo(user,std::string(msg));
  74                 aw = new awaylog;
  75                 user->Extend("park_awaylog",(char*)aw);
  76                 user->Extend("park_key",(char*)key);
  77                 pi.nick = user->nick;
  78                 pi.host = user->host;
  79                 pi.parktime = time(NULL);
  80                 pinfo.push_back(pi);
  81         }
  82 }
  83
  84 void handle_parkstats(char **parameters, int pcnt, userrec *user)
  85 {
  86         char status[MAXBUF];
  87         snprintf(status,MAXBUF,"NOTICE %s :There are a total of %d parked clients on this server, with a maximum of %d parked sessions allowed per user.",user->nick,pinfo.size(),ConcurrentParks);
  88         Srv->SendServ(user->fd,status);
  89 }
  90
  91 void handle_unpark(char **parameters, int pcnt, userrec *user)
  92 {
  93         /** Unparking. complicated stuff.
  94          *
  95          * Unparking is done in several steps:
  96          *
  97          * (1) Check if the user is parked
  98          * (2) Check the key of the user against the one provided
  99          * (3) Part the user who issued the command from all of their channels so as not to confuse clients
 100          * (4) Remove all the users UMODEs
 101          * (5) Duplicate and switch file descriptors on the two users, and disconnect the dead one
 102          * (6) Force a nickchange onto the user who issued the command forcing them to change to the parked nick
 103          * (7) Force join the user into all the channels the parked nick is currently in (send them localized join and namelist)
 104          * (8) Send the user the umodes of their new 'persona'
 105          * (9) Spool any awaylog messages to the user
 106          *
 107          * And there you have it, easy huh (NOT)...
 108          */
 109         userrec* unpark = Srv->FindNick(std::string(parameters[0]));
 110         if (!unpark)
 111         {
 112                 WriteServ(user->fd,"942 %s %s :Invalid user specified.",user->nick, parameters[0]);
 113                 return;
 114         }
 115         awaylog* awy = (awaylog*)unpark->GetExt("park_awaylog");
 116         long key = (long)unpark->GetExt("park_key");
 117         if (!awy)
 118         {
 119                 WriteServ(user->fd,"943 %s %s :This user is not parked.",user->nick, unpark->nick);
 120                 return;
 121         }
 122         if (key == atoi(parameters[1]))
 123         {
 124                 // first part the user from all chans theyre on, so things dont get messy
 125                 for (int i = 0; i != MAXCHANS; i++)
 126                 {
 127                         if (user->chans[i].channel != NULL)
 128                         {
 129                                 if (user->chans[i].channel->name)
 130                                 {
 131                                         Srv->PartUserFromChannel(user,user->chans[i].channel->name,"Unparking");
 132                                 }
 133                         }
 134                 }
 135                 // remove all their old modes
 136                 WriteServ(user->fd,"MODE %s -%s",user->nick,user->modes);
 137                 // now, map them to the parked user, while nobody can see :p
 138                 Srv->PseudoToUser(user,unpark,"Unparked to "+std::string(parameters[0]));
 139                 // set all their new modes
 140                 WriteServ(unpark->fd,"MODE %s +%s",unpark->nick,unpark->modes);
 141                 // spool their away log to them
 142                 WriteServ(unpark->fd,"NOTICE %s :*** You are now unparked. You have successfully taken back the nickname and privilages of %s.",unpark->nick,unpark->nick);
 143                 for (awaylog::iterator i = awy->begin(); i != awy->end(); i++)
 144                 {
 145                         char timebuf[MAXBUF];
 146                         tm *timeinfo = localtime(&i->tm);
 147                         strlcpy(timebuf,asctime(timeinfo),MAXBUF);
 148                         timebuf[strlen(timebuf)-1] = '\0';
 149                         WriteServ(unpark->fd,"NOTICE %s :From %s at %s: \2%s\2",unpark->nick,i->from.c_str(),timebuf,i->text.c_str());
 150                 }
 151                 delete awy;
 152                 unpark->Shrink("park_awaylog");
 153                 unpark->Shrink("park_key");
 154                 for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
 155                 {
 156                         if (j->nick == std::string(unpark->nick))
 157                         {
 158                                 pinfo.erase(j);
 159                                 break;
 160                         }
 161                 }
 162         }
 163         else
 164         {
 165                 Srv->SendServ(user->fd,"928 "+std::string(user->nick)+" :Incorrect park key.");
 166         }
 167 }
 168
 169
 170 class ModulePark : public Module
 171 {
 172  protected:
 173         ConfigReader* Conf;
 174  public:
 175         virtual void ReadSettings()
 176         {
 177                 Conf = new ConfigReader;
 178                 ParkMaxTime = Conf->ReadInteger("park","maxtime",0,true);
 179                 ConcurrentParks = Conf->ReadInteger("park","maxperip",0,true);
 180                 ParkMaxMsgs = Conf->ReadInteger("park","maxmessages",0,true);
 181                 delete Conf;
 182         }
 183
 184         ModulePark()
 185         {
 186                 Srv = new Server;
 187                 pinfo.clear();
 188                 this->ReadSettings();
 189                 Srv->AddCommand("PARK",handle_park,0,0,"m_park.so");
 190                 Srv->AddCommand("UNPARK",handle_unpark,0,2,"m_park.so");
 191                 Srv->AddCommand("PARKSTATS",handle_parkstats,'o',0,"m_park.so");
 192         }
 193
 194         virtual ~ModulePark()
 195         {
 196                 delete Srv;
 197         }
 198
 199         virtual void OnRehash()
 200         {
 201                 this->ReadSettings();
 202         }
 203
 204         virtual void On005Numeric(std::string &output)
 205         {
 206                 output = output + std::string(" PARK");
 207         }
 208
 209         virtual void OnUserQuit(userrec* user)
 210         {
 211                 std::string nick = user->nick;
 212                 // track quits in our parked user list
 213                 for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
 214                 {
 215                         if (j->nick == nick)
 216                         {
 217                                 pinfo.erase(j);
 218                                 break;
 219                         }
 220                 }
 221         }
 222
 223
 224         virtual void OnPrePrivmsg(userrec* user, userrec* dest, std::string text)
 225         {
 226                 awaylog* awy = (awaylog*)dest->GetExt("park_awaylog");
 227                 if (awy)
 228                 {
 229                         if (awy->size() <= ParkMaxMsgs)
 230                         {
 231                                 awaymsg am;
 232                                 am.text = text;
 233                                 am.from = user->GetFullHost();
 234                                 am.tm = time(NULL);
 235                                 awy->push_back(am);
 236                                 Srv->SendServ(user->fd,"930 "+std::string(user->nick)+" :User "+std::string(dest->nick)+" is parked. Your message has been stored.");
 237                         }
 238                         else Srv->SendServ(user->fd,"929 "+std::string(user->nick)+" :User "+std::string(dest->nick)+" is parked, but their message queue is full. Message not saved.");
 239                 }
 240         }
 241
 242         virtual int OnUserPreNick(userrec* user, std::string newnick)
 243         {
 244                 // track nickchanges in our parked user list
 245                 // (this isnt too efficient, i'll tidy it up some time)
 246                 for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
 247                 {
 248                         if (j->nick == std::string(user->nick))
 249                         {
 250                                 j->nick = newnick;
 251                                 break;
 252                         }
 253                 }
 254                 return 0;
 255         }
 256
 257         virtual void OnBackgroundTimer(time_t curtime)
 258         {
 259                 // look for parked clients which have timed out (this needs tidying)
 260                 if (pinfo.empty())
 261                         return;
 262                 bool go_again = true;
 263                 while (go_again)
 264                 {
 265                         go_again = false;
 266                         for (parkinfo::iterator j = pinfo.begin(); j != pinfo.end(); j++)
 267                         {
 268                                 if (time(NULL) >= (j->parktime+ParkMaxTime))
 269                                 {
 270                                         userrec* thisnick = Srv->FindNick(j->nick);
 271                                         // THIS MUST COME BEFORE THE QuitUser - QuitUser can
 272                                         // create a recursive call to OnUserQuit in this module
 273                                         // and then corrupt the pointer!
 274                                         pinfo.erase(j);
 275                                         if (thisnick)
 276                                                 Srv->QuitUser(thisnick,"PARK timeout");
 277                                         go_again = true;
 278                                         break;
 279                                 }
 280                         }
 281                 }
 282         }
 283
 284         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text)
 285         {
 286                 if (target_type == TYPE_USER)
 287                 {
 288                         userrec* u = (userrec*)dest;
 289                         OnPrePrivmsg(user,u,text);
 290                         return 1;
 291                 }
 292                 return 0;
 293         }
 294
 295         virtual void OnWhois(userrec* src, userrec* dst)
 296         {
 297                 if (dst->GetExt("park_awaylog"))
 298                         Srv->SendTo(NULL,src,"335 "+std::string(src->nick)+" "+std::string(dst->nick)+" :is a parked client");
 299         }
 300
 301         virtual Version GetVersion()
 302         {
 303                 return Version(1,0,0,1,VF_VENDOR);
 304         }
 305
 306 };
 307
 308 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 309
 310 class ModuleParkFactory : public ModuleFactory
 311 {
 312  public:
 313         ModuleParkFactory()
 314         {
 315         }
 316
 317         ~ModuleParkFactory()
 318         {
 319         }
 320
 321         virtual Module * CreateModule()
 322         {
 323                 return new ModulePark;
 324         }
 325
 326 };
 327
 328
 329 extern "C" void * init_module( void )
 330 {
 331         return new ModuleParkFactory;
 332 }
 333