src/modules/m_cap.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   6  *
   7  * This file is part of InspIRCd.  InspIRCd is free software: you can
   8  * redistribute it and/or modify it under the terms of the GNU General Public
   9  * License as published by the Free Software Foundation, version 2.
  10  *
  11  * This program is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  13  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  14  * details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20
  21 #include "inspircd.h"
  22 #include "m_cap.h"
  23
  24 /* $ModDesc: Provides the CAP negotiation mechanism seen in ratbox-derived ircds */
  25
  26 /*
  27 CAP LS
  28 :alfred.staticbox.net CAP * LS :multi-prefix sasl
  29 CAP REQ :multi-prefix
  30 :alfred.staticbox.net CAP * ACK :multi-prefix
  31 CAP CLEAR
  32 :alfred.staticbox.net CAP * ACK :-multi-prefix
  33 CAP REQ :multi-prefix
  34 :alfred.staticbox.net CAP * ACK :multi-prefix
  35 CAP LIST
  36 :alfred.staticbox.net CAP * LIST :multi-prefix
  37 CAP END
  38 */
  39
  40 /** Handle /CAP
  41  */
  42 class CommandCAP : public Command
  43 {
  44  public:
  45         LocalIntExt reghold;
  46         CommandCAP (Module* mod) : Command(mod, "CAP", 1),
  47                 reghold("CAP_REGHOLD", mod)
  48         {
  49                 works_before_reg = true;
  50         }
  51
  52         CmdResult Handle (const std::vector<std::string> &parameters, User *user)
  53         {
  54                 irc::string subcommand = parameters[0].c_str();
  55
  56                 if (subcommand == "REQ")
  57                 {
  58                         if (parameters.size() < 2)
  59                                 return CMD_FAILURE;
  60
  61                         CapEvent Data(creator, user, CapEvent::CAPEVENT_REQ);
  62
  63                         // tokenize the input into a nice list of requested caps
  64                         std::string cap_;
  65                         irc::spacesepstream cap_stream(parameters[1]);
  66
  67                         while (cap_stream.GetToken(cap_))
  68                         {
  69                                 // Whilst the handling of extraneous spaces is not currently defined in the CAP specification
  70                                 // every single other implementation ignores extraneous spaces. Lets copy them for
  71                                 // compatibility purposes.
  72                                 trim(cap_);
  73                                 if (!cap_.empty())
  74                                         Data.wanted.push_back(cap_);
  75                         }
  76
  77                         reghold.set(user, 1);
  78                         Data.Send();
  79
  80                         if (Data.wanted.empty())
  81                         {
  82                                 user->WriteServ("CAP %s ACK :%s", user->nick.c_str(), parameters[1].c_str());
  83                                 return CMD_SUCCESS;
  84                         }
  85
  86                         // HACK: reset all of the caps which were enabled on this user because a cap request is atomic.
  87                         for (std::vector<std::pair<GenericCap*, int> >::iterator iter = Data.changed.begin(); iter != Data.changed.end(); ++iter)
  88                                 iter->first->ext.set(user, iter->second);
  89
  90                         user->WriteServ("CAP %s NAK :%s", user->nick.c_str(), parameters[1].c_str());
  91                 }
  92                 else if (subcommand == "END")
  93                 {
  94                         reghold.set(user, 0);
  95                 }
  96                 else if ((subcommand == "LS") || (subcommand == "LIST"))
  97                 {
  98                         CapEvent Data(creator, user, subcommand == "LS" ? CapEvent::CAPEVENT_LS : CapEvent::CAPEVENT_LIST);
  99
 100                         reghold.set(user, 1);
 101                         Data.Send();
 102
 103                         std::string Result;
 104                         if (Data.wanted.size() > 0)
 105                                 Result = irc::stringjoiner(" ", Data.wanted, 0, Data.wanted.size() - 1).GetJoined();
 106
 107                         user->WriteServ("CAP %s %s :%s", user->nick.c_str(), subcommand.c_str(), Result.c_str());
 108                 }
 109                 else if (subcommand == "CLEAR")
 110                 {
 111                         CapEvent Data(creator, user, CapEvent::CAPEVENT_CLEAR);
 112
 113                         reghold.set(user, 1);
 114                         Data.Send();
 115
 116                         std::string Result;
 117                         if (!Data.ack.empty())
 118                                 Result = irc::stringjoiner(" ", Data.ack, 0, Data.ack.size() - 1).GetJoined();
 119                         user->WriteServ("CAP %s ACK :%s", user->nick.c_str(), Result.c_str());
 120                 }
 121                 else
 122                 {
 123                         user->WriteNumeric(ERR_INVALIDCAPSUBCOMMAND, "%s %s :Invalid CAP subcommand", user->nick.c_str(), subcommand.c_str());
 124                         return CMD_FAILURE;
 125                 }
 126
 127                 return CMD_SUCCESS;
 128         }
 129 };
 130
 131 class ModuleCAP : public Module
 132 {
 133         CommandCAP cmd;
 134  public:
 135         ModuleCAP()
 136                 : cmd(this)
 137         {
 138         }
 139
 140         void init()
 141         {
 142                 ServerInstance->Modules->AddService(cmd);
 143                 ServerInstance->Modules->AddService(cmd.reghold);
 144
 145                 Implementation eventlist[] = { I_OnCheckReady };
 146                 ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
 147         }
 148
 149         ModResult OnCheckReady(LocalUser* user)
 150         {
 151                 /* Users in CAP state get held until CAP END */
 152                 if (cmd.reghold.get(user))
 153                         return MOD_RES_DENY;
 154
 155                 return MOD_RES_PASSTHRU;
 156         }
 157
 158         ~ModuleCAP()
 159         {
 160         }
 161
 162         Version GetVersion()
 163         {
 164                 return Version("Client CAP extension support", VF_VENDOR);
 165         }
 166 };
 167
 168 MODULE_INIT(ModuleCAP)
 169