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