src/modules/m_ircv3.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2012 Attila Molnar <attilamolnar@hush.com>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include "inspircd.h"
  20 #include "modules/account.h"
  21 #include "modules/cap.h"
  22
  23 class WriteNeighboursWithExt : public User::ForEachNeighborHandler
  24 {
  25         const LocalIntExt& ext;
  26         const std::string& msg;
  27
  28         void Execute(LocalUser* user) CXX11_OVERRIDE
  29         {
  30                 if (ext.get(user))
  31                         user->Write(msg);
  32         }
  33
  34  public:
  35         WriteNeighboursWithExt(User* user, const std::string& message, const LocalIntExt& extension)
  36                 : ext(extension)
  37                 , msg(message)
  38         {
  39                 user->ForEachNeighbor(*this, false);
  40         }
  41 };
  42
  43 class ModuleIRCv3 : public Module, public AccountEventListener
  44 {
  45         GenericCap cap_accountnotify;
  46         GenericCap cap_awaynotify;
  47         GenericCap cap_extendedjoin;
  48         bool accountnotify;
  49         bool awaynotify;
  50         bool extendedjoin;
  51
  52         CUList last_excepts;
  53
  54  public:
  55         ModuleIRCv3()
  56                 : AccountEventListener(this)
  57                 , cap_accountnotify(this, "account-notify"),
  58                                         cap_awaynotify(this, "away-notify"),
  59                                         cap_extendedjoin(this, "extended-join")
  60         {
  61         }
  62
  63         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
  64         {
  65                 ConfigTag* conf = ServerInstance->Config->ConfValue("ircv3");
  66                 accountnotify = conf->getBool("accountnotify", true);
  67                 awaynotify = conf->getBool("awaynotify", true);
  68                 extendedjoin = conf->getBool("extendedjoin", true);
  69         }
  70
  71         void OnEvent(Event& ev) CXX11_OVERRIDE
  72         {
  73                 if (awaynotify)
  74                         cap_awaynotify.HandleEvent(ev);
  75                 if (extendedjoin)
  76                         cap_extendedjoin.HandleEvent(ev);
  77
  78                 if (accountnotify)
  79                         cap_accountnotify.HandleEvent(ev);
  80         }
  81
  82         void OnAccountChange(User* user, const std::string& newaccount) CXX11_OVERRIDE
  83         {
  84                 // :nick!user@host ACCOUNT account
  85                 // or
  86                 // :nick!user@host ACCOUNT *
  87                 std::string line = ":" + user->GetFullHost() + " ACCOUNT ";
  88                 if (newaccount.empty())
  89                         line += "*";
  90                 else
  91                         line += newaccount;
  92
  93                 WriteNeighboursWithExt(user, line, cap_accountnotify.ext);
  94         }
  95
  96         void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE
  97         {
  98                 // Remember who is not going to see the JOIN because of other modules
  99                 if ((awaynotify) && (memb->user->IsAway()))
 100                         last_excepts = excepts;
 101
 102                 if (!extendedjoin)
 103                         return;
 104
 105                 /*
 106                  * Send extended joins to clients who have the extended-join capability.
 107                  * An extended join looks like this:
 108                  *
 109                  * :nick!user@host JOIN #chan account :realname
 110                  *
 111                  * account is the joining user's account if he's logged in, otherwise it's an asterisk (*).
 112                  */
 113
 114                 std::string line;
 115                 std::string mode;
 116
 117                 const Channel::MemberMap& userlist = memb->chan->GetUsers();
 118                 for (Channel::MemberMap::const_iterator it = userlist.begin(); it != userlist.end(); ++it)
 119                 {
 120                         // Send the extended join line if the current member is local, has the extended-join cap and isn't excepted
 121                         User* member = IS_LOCAL(it->first);
 122                         if ((member) && (cap_extendedjoin.ext.get(member)) && (excepts.find(member) == excepts.end()))
 123                         {
 124                                 // Construct the lines we're going to send if we haven't constructed them already
 125                                 if (line.empty())
 126                                 {
 127                                         bool has_account = false;
 128                                         line = ":" + memb->user->GetFullHost() + " JOIN " + memb->chan->name + " ";
 129                                         const AccountExtItem* accountext = GetAccountExtItem();
 130                                         if (accountext)
 131                                         {
 132                                                 std::string* accountname;
 133                                                 accountname = accountext->get(memb->user);
 134                                                 if (accountname)
 135                                                 {
 136                                                         line += *accountname;
 137                                                         has_account = true;
 138                                                 }
 139                                         }
 140
 141                                         if (!has_account)
 142                                                 line += "*";
 143
 144                                         line += " :" + memb->user->fullname;
 145
 146                                         // If the joining user received privileges from another module then we must send them as well,
 147                                         // since silencing the normal join means the MODE will be silenced as well
 148                                         if (!memb->modes.empty())
 149                                         {
 150                                                 const std::string& modefrom = ServerInstance->Config->CycleHostsFromUser ? memb->user->GetFullHost() : ServerInstance->Config->ServerName;
 151                                                 mode = ":" + modefrom + " MODE " + memb->chan->name + " +" + memb->modes;
 152
 153                                                 for (unsigned int i = 0; i < memb->modes.length(); i++)
 154                                                         mode += " " + memb->user->nick;
 155                                         }
 156                                 }
 157
 158                                 // Write the JOIN and the MODE, if any
 159                                 member->Write(line);
 160                                 if ((!mode.empty()) && (member != memb->user))
 161                                         member->Write(mode);
 162
 163                                 // Prevent the core from sending the JOIN and MODE to this user
 164                                 excepts.insert(it->first);
 165                         }
 166                 }
 167         }
 168
 169         ModResult OnSetAway(User* user, const std::string &awaymsg) CXX11_OVERRIDE
 170         {
 171                 if (awaynotify)
 172                 {
 173                         // Going away: n!u@h AWAY :reason
 174                         // Back from away: n!u@h AWAY
 175                         std::string line = ":" + user->GetFullHost() + " AWAY";
 176                         if (!awaymsg.empty())
 177                                 line += " :" + awaymsg;
 178
 179                         WriteNeighboursWithExt(user, line, cap_awaynotify.ext);
 180                 }
 181                 return MOD_RES_PASSTHRU;
 182         }
 183
 184         void OnPostJoin(Membership *memb) CXX11_OVERRIDE
 185         {
 186                 if ((!awaynotify) || (!memb->user->IsAway()))
 187                         return;
 188
 189                 std::string line = ":" + memb->user->GetFullHost() + " AWAY :" + memb->user->awaymsg;
 190
 191                 const Channel::MemberMap& userlist = memb->chan->GetUsers();
 192                 for (Channel::MemberMap::const_iterator it = userlist.begin(); it != userlist.end(); ++it)
 193                 {
 194                         // Send the away notify line if the current member is local, has the away-notify cap and isn't excepted
 195                         User* member = IS_LOCAL(it->first);
 196                         if ((member) && (cap_awaynotify.ext.get(member)) && (last_excepts.find(member) == last_excepts.end()))
 197                         {
 198                                 member->Write(line);
 199                         }
 200                 }
 201
 202                 last_excepts.clear();
 203         }
 204
 205         void Prioritize()
 206         {
 207                 ServerInstance->Modules->SetPriority(this, I_OnUserJoin, PRIORITY_LAST);
 208         }
 209
 210         Version GetVersion() CXX11_OVERRIDE
 211         {
 212                 return Version("Provides support for extended-join, away-notify and account-notify CAP capabilities", VF_VENDOR);
 213         }
 214 };
 215
 216 MODULE_INIT(ModuleIRCv3)