src/modules/m_auditorium.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24
  25 /* $ModDesc: Allows for auditorium channels (+u) where nobody can see others joining and parting or the nick list */
  26
  27 class AuditoriumMode : public ModeHandler
  28 {
  29  public:
  30         AuditoriumMode(Module* Creator) : ModeHandler(Creator, "auditorium", 'u', PARAM_NONE, MODETYPE_CHANNEL)
  31         {
  32                 levelrequired = OP_VALUE;
  33         }
  34
  35         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
  36         {
  37                 if (channel->IsModeSet(this) == adding)
  38                         return MODEACTION_DENY;
  39                 channel->SetMode(this, adding);
  40                 return MODEACTION_ALLOW;
  41         }
  42 };
  43
  44 class ModuleAuditorium : public Module
  45 {
  46         AuditoriumMode aum;
  47         bool OpsVisible;
  48         bool OpsCanSee;
  49         bool OperCanSee;
  50
  51  public:
  52         ModuleAuditorium() : aum(this)
  53         {
  54         }
  55
  56         void init()
  57         {
  58                 ServerInstance->Modules->AddService(aum);
  59
  60                 OnRehash(NULL);
  61
  62                 Implementation eventlist[] = {
  63                         I_OnUserJoin, I_OnUserPart, I_OnUserKick,
  64                         I_OnBuildNeighborList, I_OnNamesListItem, I_OnSendWhoLine,
  65                         I_OnRehash };
  66                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
  67         }
  68
  69         void OnRehash(User* user)
  70         {
  71                 ConfigTag* tag = ServerInstance->Config->ConfValue("auditorium");
  72                 OpsVisible = tag->getBool("opvisible");
  73                 OpsCanSee = tag->getBool("opcansee");
  74                 OperCanSee = tag->getBool("opercansee", true);
  75         }
  76
  77         Version GetVersion()
  78         {
  79                 return Version("Allows for auditorium channels (+u) where nobody can see others joining and parting or the nick list", VF_VENDOR);
  80         }
  81
  82         /* Can they be seen by everyone? */
  83         bool IsVisible(Membership* memb)
  84         {
  85                 if (!memb->chan->IsModeSet(&aum))
  86                         return true;
  87
  88                 ModResult res = ServerInstance->OnCheckExemption(memb->user, memb->chan, "auditorium-vis");
  89                 return res.check(OpsVisible && memb->getRank() >= OP_VALUE);
  90         }
  91
  92         /* Can they see this specific membership? */
  93         bool CanSee(User* issuer, Membership* memb)
  94         {
  95                 // If user is oper and operoverride is on, don't touch the list
  96                 if (OperCanSee && issuer->HasPrivPermission("channels/auspex"))
  97                         return true;
  98
  99                 // You can always see yourself
 100                 if (issuer == memb->user)
 101                         return true;
 102
 103                 // Can you see the list by permission?
 104                 ModResult res = ServerInstance->OnCheckExemption(issuer,memb->chan,"auditorium-see");
 105                 if (res.check(OpsCanSee && memb->chan->GetPrefixValue(issuer) >= OP_VALUE))
 106                         return true;
 107
 108                 return false;
 109         }
 110
 111         void OnNamesListItem(User* issuer, Membership* memb, std::string &prefixes, std::string &nick)
 112         {
 113                 // Some module already hid this from being displayed, don't bother
 114                 if (nick.empty())
 115                         return;
 116
 117                 if (IsVisible(memb))
 118                         return;
 119
 120                 if (CanSee(issuer, memb))
 121                         return;
 122
 123                 nick.clear();
 124         }
 125
 126         /** Build CUList for showing this join/part/kick */
 127         void BuildExcept(Membership* memb, CUList& excepts)
 128         {
 129                 if (IsVisible(memb))
 130                         return;
 131
 132                 const UserMembList* users = memb->chan->GetUsers();
 133                 for(UserMembCIter i = users->begin(); i != users->end(); i++)
 134                 {
 135                         if (IS_LOCAL(i->first) && !CanSee(i->first, memb))
 136                                 excepts.insert(i->first);
 137                 }
 138         }
 139
 140         void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts)
 141         {
 142                 BuildExcept(memb, excepts);
 143         }
 144
 145         void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts)
 146         {
 147                 BuildExcept(memb, excepts);
 148         }
 149
 150         void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts)
 151         {
 152                 BuildExcept(memb, excepts);
 153         }
 154
 155         void OnBuildNeighborList(User* source, UserChanList &include, std::map<User*,bool> &exception)
 156         {
 157                 UCListIter i = include.begin();
 158                 while (i != include.end())
 159                 {
 160                         Channel* c = *i++;
 161                         Membership* memb = c->GetUser(source);
 162                         if (!memb || IsVisible(memb))
 163                                 continue;
 164                         // this channel should not be considered when listing my neighbors
 165                         include.erase(c);
 166                         // however, that might hide me from ops that can see me...
 167                         const UserMembList* users = c->GetUsers();
 168                         for(UserMembCIter j = users->begin(); j != users->end(); j++)
 169                         {
 170                                 if (IS_LOCAL(j->first) && CanSee(j->first, memb))
 171                                         exception[j->first] = true;
 172                         }
 173                 }
 174         }
 175
 176         void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, std::string& line)
 177         {
 178                 Channel* channel = ServerInstance->FindChan(params[0]);
 179                 if (!channel)
 180                         return;
 181                 Membership* memb = channel->GetUser(user);
 182                 if (IsVisible(memb))
 183                         return;
 184                 if (CanSee(source, memb))
 185                         return;
 186                 line.clear();
 187         }
 188 };
 189
 190 MODULE_INIT(ModuleAuditorium)