src/modules/m_invisible.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/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 <stdarg.h>
  16
  17 /* $ModDesc: Allows for opered clients to join channels without being seen, similar to unreal 3.1 +I mode */
  18
  19 static ConfigReader* conf;
  20
  21 class QuietOper : public VisData
  22 {
  23  public:
  24         QuietOper()
  25         {
  26         }
  27
  28         virtual ~QuietOper()
  29         {
  30         }
  31
  32         virtual bool VisibleTo(User* user)
  33         {
  34                 return IS_OPER(user);
  35         }
  36 };
  37
  38
  39 class InvisibleMode : public ModeHandler
  40 {
  41         QuietOper* qo;
  42  public:
  43         InvisibleMode(InspIRCd* Instance) : ModeHandler(Instance, 'Q', 0, 0, false, MODETYPE_USER, true)
  44         {
  45                 qo = new QuietOper();
  46         }
  47
  48         ~InvisibleMode()
  49         {
  50                 for (user_hash::iterator i = ServerInstance->Users->clientlist->begin(); i != ServerInstance->Users->clientlist->end(); i++)
  51                         if (i->second->Visibility == qo)
  52                                 i->second->Visibility = NULL;
  53                 delete qo;
  54         }
  55
  56         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool)
  57         {
  58                 if (source != dest)
  59                         return MODEACTION_DENY;
  60
  61                 if (dest->IsModeSet('Q') != adding)
  62                 {
  63                         bool ok = false;
  64
  65                         for (int j = 0; j < conf->Enumerate("type"); j++)
  66                         {
  67                                 std::string opertype = conf->ReadValue("type","name",j);
  68                                 if (opertype == source->oper)
  69                                 {
  70                                         ok = conf->ReadFlag("type", "canquiet", j);
  71                                         break;
  72                                 }
  73                         }
  74
  75                         if (!ok)
  76                         {
  77                                 source->WriteNumeric(481, "%s :Permission Denied - You do not have access to become invisible via user mode +Q", source->nick.c_str());
  78                                 return MODEACTION_DENY;
  79                         }
  80
  81                         dest->SetMode('Q', adding);
  82
  83                         /* Fix for bug #379 reported by stealth. On +/-Q make m_watch think the user has signed on/off */
  84                         Module* m = ServerInstance->Modules->Find("m_watch.so");
  85
  86                         /* This must come before setting/unsetting the handler */
  87                         if (m && adding)
  88                                 m->OnUserQuit(dest, "Connection closed", "Connection closed");
  89
  90                         /* Set visibility handler object */
  91                         dest->Visibility = adding ? qo : NULL;
  92
  93                         /* This has to come after setting/unsetting the handler */
  94                         if (m && !adding)
  95                                 m->OnPostConnect(dest);
  96
  97                         /* User appears to vanish or appear from nowhere */
  98                         for (UCListIter f = dest->chans.begin(); f != dest->chans.end(); f++)
  99                         {
 100                                 CUList *ulist = f->first->GetUsers();
 101                                 char tb[MAXBUF];
 102
 103                                 snprintf(tb,MAXBUF,":%s %s %s", dest->GetFullHost().c_str(), adding ? "PART" : "JOIN", f->first->name.c_str());
 104                                 std::string out = tb;
 105                                 std::string n = this->ServerInstance->Modes->ModeString(dest, f->first);
 106
 107                                 for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
 108                                 {
 109                                         /* User only appears to vanish for non-opers */
 110                                         if (IS_LOCAL(i->first) && !IS_OPER(i->first))
 111                                         {
 112                                                 i->first->Write(out);
 113                                                 if (!n.empty() && !adding)
 114                                                         i->first->WriteServ("MODE %s +%s", f->first->name.c_str(), n.c_str());
 115                                         }
 116                                 }
 117                         }
 118
 119                         ServerInstance->SNO->WriteToSnoMask('A', "\2NOTICE\2: Oper %s has become %svisible (%sQ)", dest->GetFullHost().c_str(), adding ? "in" : "", adding ? "+" : "-");
 120                         return MODEACTION_ALLOW;
 121                 }
 122                 else
 123                 {
 124                         return MODEACTION_DENY;
 125                 }
 126         }
 127 };
 128
 129 class InvisibleDeOper : public ModeWatcher
 130 {
 131  private:
 132         InspIRCd* Srv;
 133  public:
 134         InvisibleDeOper(InspIRCd* Instance) : ModeWatcher(Instance, 'o', MODETYPE_USER), Srv(Instance)
 135         {
 136         }
 137
 138         bool BeforeMode(User* source, User* dest, Channel* channel, std::string &param, bool adding, ModeType type, bool)
 139         {
 140                 /* Users who are opers and have +Q get their +Q removed when they deoper */
 141                 if ((!adding) && (dest->IsModeSet('Q')))
 142                 {
 143                         std::vector<std::string> newmodes;
 144                         newmodes.push_back(dest->nick);
 145                         newmodes.push_back("-Q");
 146                         ServerInstance->Modes->Process(newmodes, source, true);
 147                 }
 148                 return true;
 149         }
 150 };
 151
 152
 153 class ModuleInvisible : public Module
 154 {
 155  private:
 156         InvisibleMode* qm;
 157         InvisibleDeOper* ido;
 158  public:
 159         ModuleInvisible(InspIRCd* Me)
 160                 : Module(Me)
 161         {
 162                 conf = new ConfigReader(ServerInstance);
 163                 qm = new InvisibleMode(ServerInstance);
 164                 if (!ServerInstance->Modes->AddMode(qm))
 165                         throw ModuleException("Could not add new modes!");
 166                 ido = new InvisibleDeOper(ServerInstance);
 167                 if (!ServerInstance->Modes->AddModeWatcher(ido))
 168                         throw ModuleException("Could not add new mode watcher on usermode +o!");
 169
 170                 /* Yeah i know people can take this out. I'm not about to obfuscate code just to be a pain in the ass. */
 171                 ServerInstance->Users->ServerNoticeAll("*** m_invisible.so has just been loaded on this network. For more information, please visit http://inspircd.org/wiki/Modules/invisible");
 172                 Implementation eventlist[] = { I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserJoin, I_OnUserPart, I_OnUserQuit, I_OnRehash };
 173                 ServerInstance->Modules->Attach(eventlist, this, 6);
 174         };
 175
 176         virtual ~ModuleInvisible()
 177         {
 178                 ServerInstance->Modes->DelMode(qm);
 179                 ServerInstance->Modes->DelModeWatcher(ido);
 180                 delete qm;
 181                 delete ido;
 182                 delete conf;
 183         };
 184
 185         virtual Version GetVersion();
 186         virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
 187         virtual void OnRehash(User* user, const std::string &parameter);
 188         void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
 189         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
 190         /* No privmsg response when hiding - submitted by Eric at neowin */
 191         virtual int OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
 192         virtual int OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list);
 193         /* Fix by Eric @ neowin.net, thanks :) -- Brain */
 194         void WriteCommonFrom(User *user, Channel* channel, const char* text, ...) CUSTOM_PRINTF(4, 5);
 195 };
 196
 197 Version ModuleInvisible::GetVersion()
 198 {
 199         return Version("$Id$", VF_COMMON | VF_VENDOR, API_VERSION);
 200 }
 201
 202 void ModuleInvisible::OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
 203 {
 204         if (user->IsModeSet('Q'))
 205         {
 206                 silent = true;
 207                 /* Because we silenced the event, make sure it reaches the user whos joining (but only them of course) */
 208                 this->WriteCommonFrom(user, channel, "JOIN %s", channel->name.c_str());
 209                 ServerInstance->SNO->WriteToSnoMask('A', "\2NOTICE\2: Oper %s has joined %s invisibly (+Q)", user->GetFullHost().c_str(), channel->name.c_str());
 210         }
 211 }
 212
 213 void ModuleInvisible::OnRehash(User* user, const std::string &parameter)
 214 {
 215         delete conf;
 216         conf = new ConfigReader(ServerInstance);
 217 }
 218
 219 void ModuleInvisible::OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent)
 220 {
 221         if (user->IsModeSet('Q'))
 222         {
 223                 silent = true;
 224                 /* Because we silenced the event, make sure it reaches the user whos leaving (but only them of course) */
 225                 this->WriteCommonFrom(user, channel, "PART %s%s%s", channel->name.c_str(),
 226                                 partmessage.empty() ? "" : " :",
 227                                 partmessage.empty() ? "" : partmessage.c_str());
 228         }
 229 }
 230
 231 void ModuleInvisible::OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
 232 {
 233         if (user->IsModeSet('Q'))
 234         {
 235                 Command* parthandler = ServerInstance->Parser->GetHandler("PART");
 236                 std::vector<std::string> to_leave;
 237                 if (parthandler)
 238                 {
 239                         for (UCListIter f = user->chans.begin(); f != user->chans.end(); f++)
 240                                         to_leave.push_back(f->first->name);
 241                         /* We cant do this neatly in one loop, as we are modifying the map we are iterating */
 242                         for (std::vector<std::string>::iterator n = to_leave.begin(); n != to_leave.end(); n++)
 243                         {
 244                                 std::vector<std::string> parameters;
 245                                 parameters.push_back(*n);
 246                                 /* This triggers our OnUserPart, above, making the PART silent */
 247                                 parthandler->Handle(parameters, user);
 248                         }
 249                 }
 250         }
 251 }
 252
 253 /* No privmsg response when hiding - submitted by Eric at neowin */
 254 int ModuleInvisible::OnUserPreNotice(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 255 {
 256         if ((target_type == TYPE_USER) && (IS_LOCAL(user)))
 257         {
 258                 User* target = (User*)dest;
 259                 if(target->IsModeSet('Q') && !IS_OPER(user))
 260                 {
 261                         user->WriteNumeric(401, "%s %s :No such nick/channel",user->nick.c_str(), target->nick.c_str());
 262                         return 1;
 263                 }
 264         }
 265         return 0;
 266 }
 267
 268 int ModuleInvisible::OnUserPreMessage(User* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
 269 {
 270         return OnUserPreNotice(user, dest, target_type, text, status, exempt_list);
 271 }
 272
 273 /* Fix by Eric @ neowin.net, thanks :) -- Brain */
 274 void ModuleInvisible::WriteCommonFrom(User *user, Channel* channel, const char* text, ...)
 275 {
 276         va_list argsPtr;
 277         char textbuffer[MAXBUF];
 278         char tb[MAXBUF];
 279
 280         va_start(argsPtr, text);
 281         vsnprintf(textbuffer, MAXBUF, text, argsPtr);
 282         va_end(argsPtr);
 283         snprintf(tb,MAXBUF,":%s %s",user->GetFullHost().c_str(), textbuffer);
 284
 285         CUList *ulist = channel->GetUsers();
 286
 287         for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
 288         {
 289                 /* User only appears to vanish for non-opers */
 290                 if (IS_LOCAL(i->first) && IS_OPER(i->first))
 291                 {
 292                         i->first->Write(std::string(tb));
 293                 }
 294         }
 295 }
 296
 297 MODULE_INIT(ModuleInvisible)