src/coremods/core_message.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2017-2019 Sadie Powell <sadie@witchery.services>
   5  *   Copyright (C) 2013, 2017-2018 Attila Molnar <attilamolnar@hush.com>
   6  *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
   7  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   8  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   9  *   Copyright (C) 2006-2007, 2010 Craig Edwards <brain@inspircd.org>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #include "inspircd.h"
  26
  27 enum
  28 {
  29         // From RFC 2812.
  30         ERR_NOSUCHSERVICE = 408
  31 };
  32
  33 class MessageDetailsImpl : public MessageDetails
  34 {
  35 public:
  36         MessageDetailsImpl(MessageType mt, const std::string& msg, const ClientProtocol::TagMap& tags)
  37                 : MessageDetails(mt, msg, tags)
  38         {
  39         }
  40
  41         bool IsCTCP(std::string& name, std::string& body) const CXX11_OVERRIDE
  42         {
  43                 if (!this->IsCTCP())
  44                         return false;
  45
  46                 size_t end_of_name = text.find(' ', 2);
  47                 size_t end_of_ctcp = *text.rbegin() == '\x1' ? 1 : 0;
  48                 if (end_of_name == std::string::npos)
  49                 {
  50                         // The CTCP only contains a name.
  51                         name.assign(text, 1, text.length() - 1 - end_of_ctcp);
  52                         body.clear();
  53                         return true;
  54                 }
  55
  56                 // The CTCP contains a name and a body.
  57                 name.assign(text, 1, end_of_name - 1);
  58
  59                 size_t start_of_body = text.find_first_not_of(' ', end_of_name + 1);
  60                 if (start_of_body == std::string::npos)
  61                 {
  62                         // The CTCP body is provided but empty.
  63                         body.clear();
  64                         return true;
  65                 }
  66
  67                 // The CTCP body provided was non-empty.
  68                 body.assign(text, start_of_body, text.length() - start_of_body - end_of_ctcp);
  69                 return true;
  70         }
  71
  72         bool IsCTCP(std::string& name) const CXX11_OVERRIDE
  73         {
  74                 if (!this->IsCTCP())
  75                         return false;
  76
  77                 size_t end_of_name = text.find(' ', 2);
  78                 if (end_of_name == std::string::npos)
  79                 {
  80                         // The CTCP only contains a name.
  81                         size_t end_of_ctcp = *text.rbegin() == '\x1' ? 1 : 0;
  82                         name.assign(text, 1, text.length() - 1 - end_of_ctcp);
  83                         return true;
  84                 }
  85
  86                 // The CTCP contains a name and a body.
  87                 name.assign(text, 1, end_of_name - 1);
  88                 return true;
  89         }
  90
  91         bool IsCTCP() const CXX11_OVERRIDE
  92         {
  93                 // According to draft-oakley-irc-ctcp-02 a valid CTCP must begin with SOH and
  94                 // contain at least one octet which is not NUL, SOH, CR, LF, or SPACE. As most
  95                 // of these are restricted at the protocol level we only need to check for SOH
  96                 // and SPACE.
  97                 return (text.length() >= 2) && (text[0] == '\x1') &&  (text[1] != '\x1') && (text[1] != ' ');
  98         }
  99 };
 100
 101 namespace
 102 {
 103         bool FirePreEvents(User* source, MessageTarget& msgtarget, MessageDetails& msgdetails)
 104         {
 105                 // Inform modules that a message wants to be sent.
 106                 ModResult modres;
 107                 FIRST_MOD_RESULT(OnUserPreMessage, modres, (source, msgtarget, msgdetails));
 108                 if (modres == MOD_RES_DENY)
 109                 {
 110                         // Inform modules that a module blocked the mssage.
 111                         FOREACH_MOD(OnUserMessageBlocked, (source, msgtarget, msgdetails));
 112                         return false;
 113                 }
 114
 115                 // Check whether a module zapped the message body.
 116                 if (msgdetails.text.empty())
 117                 {
 118                         source->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
 119                         return false;
 120                 }
 121
 122                 // Inform modules that a message is about to be sent.
 123                 FOREACH_MOD(OnUserMessage, (source, msgtarget, msgdetails));
 124                 return true;
 125         }
 126
 127         CmdResult FirePostEvent(User* source, const MessageTarget& msgtarget, const MessageDetails& msgdetails)
 128         {
 129                 // If the source is local and was not sending a CTCP reply then update their idle time.
 130                 LocalUser* lsource = IS_LOCAL(source);
 131                 if (lsource && msgdetails.update_idle && (msgdetails.type != MSG_NOTICE || !msgdetails.IsCTCP()))
 132                         lsource->idle_lastmsg = ServerInstance->Time();
 133
 134                 // Inform modules that a message was sent.
 135                 FOREACH_MOD(OnUserPostMessage, (source, msgtarget, msgdetails));
 136                 return CMD_SUCCESS;
 137         }
 138 }
 139
 140 class CommandMessage : public Command
 141 {
 142  private:
 143         const MessageType msgtype;
 144
 145         CmdResult HandleChannelTarget(User* source, const Params& parameters, const char* target, PrefixMode* pm)
 146         {
 147                 Channel* chan = ServerInstance->FindChan(target);
 148                 if (!chan)
 149                 {
 150                         // The target channel does not exist.
 151                         source->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
 152                         return CMD_FAILURE;
 153                 }
 154
 155                 // Fire the pre-message events.
 156                 MessageTarget msgtarget(chan, pm ? pm->GetPrefix() : 0);
 157                 MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
 158                 msgdetails.exemptions.insert(source);
 159                 if (!FirePreEvents(source, msgtarget, msgdetails))
 160                         return CMD_FAILURE;
 161
 162                 // Send the message to the members of the channel.
 163                 ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, source, chan, msgdetails.text, msgdetails.type, msgtarget.status);
 164                 privmsg.AddTags(msgdetails.tags_out);
 165                 privmsg.SetSideEffect(true);
 166                 chan->Write(ServerInstance->GetRFCEvents().privmsg, privmsg, msgtarget.status, msgdetails.exemptions);
 167
 168                 // Create the outgoing message and message event.
 169                 return FirePostEvent(source, msgtarget, msgdetails);
 170         }
 171
 172         CmdResult HandleServerTarget(User* source, const Params& parameters)
 173         {
 174                 // If the source isn't allowed to mass message users then reject
 175                 // the attempt to mass-message users.
 176                 if (!source->HasPrivPermission("users/mass-message"))
 177                         return CMD_FAILURE;
 178
 179                 // Extract the server glob match from the target parameter.
 180                 std::string servername(parameters[0], 1);
 181
 182                 // Fire the pre-message events.
 183                 MessageTarget msgtarget(&servername);
 184                 MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
 185                 if (!FirePreEvents(source, msgtarget, msgdetails))
 186                         return CMD_FAILURE;
 187
 188                 // If the current server name matches the server name glob then send
 189                 // the message out to the local users.
 190                 if (InspIRCd::Match(ServerInstance->Config->ServerName, servername))
 191                 {
 192                         // Create the outgoing message and message event.
 193                         ClientProtocol::Messages::Privmsg message(ClientProtocol::Messages::Privmsg::nocopy, source, "$*", msgdetails.text, msgdetails.type);
 194                         message.AddTags(msgdetails.tags_out);
 195                         message.SetSideEffect(true);
 196                         ClientProtocol::Event messageevent(ServerInstance->GetRFCEvents().privmsg, message);
 197
 198                         const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
 199                         for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
 200                         {
 201                                 LocalUser* luser = *i;
 202
 203                                 // Don't send to unregistered users or the user who is the source.
 204                                 if (luser->registered != REG_ALL || luser == source)
 205                                         continue;
 206
 207                                 // Only send to non-exempt users.
 208                                 if (!msgdetails.exemptions.count(luser))
 209                                         luser->Send(messageevent);
 210                         }
 211                 }
 212
 213                 // Fire the post-message event.
 214                 return FirePostEvent(source, msgtarget, msgdetails);
 215         }
 216
 217         CmdResult HandleUserTarget(User* source, const Params& parameters)
 218         {
 219                 User* target;
 220                 if (IS_LOCAL(source))
 221                 {
 222                         // Local sources can specify either a nick or a nick@server mask as the target.
 223                         const char* targetserver = strchr(parameters[0].c_str(), '@');
 224                         if (targetserver)
 225                         {
 226                                 // The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
 227                                 target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
 228                                 if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
 229                                         target = NULL;
 230                         }
 231                         else
 232                         {
 233                                 // If the source is a local user then we only look up the target by nick.
 234                                 target = ServerInstance->FindNickOnly(parameters[0]);
 235                         }
 236                 }
 237                 else
 238                 {
 239                         // Remote users can only specify a nick or UUID as the target.
 240                         target = ServerInstance->FindNick(parameters[0]);
 241                 }
 242
 243                 if (!target || target->registered != REG_ALL)
 244                 {
 245                         // The target user does not exist or is not fully registered.
 246                         source->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
 247                         return CMD_FAILURE;
 248                 }
 249
 250                 // If the target is away then inform the user.
 251                 if (target->IsAway() && msgtype == MSG_PRIVMSG)
 252                         source->WriteNumeric(RPL_AWAY, target->nick, target->awaymsg);
 253
 254                 // Fire the pre-message events.
 255                 MessageTarget msgtarget(target);
 256                 MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
 257                 if (!FirePreEvents(source, msgtarget, msgdetails))
 258                         return CMD_FAILURE;
 259
 260                 LocalUser* const localtarget = IS_LOCAL(target);
 261                 if (localtarget)
 262                 {
 263                         // Send to the target if they are a local user.
 264                         ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, source, localtarget->nick, msgdetails.text, msgtype);
 265                         privmsg.AddTags(msgdetails.tags_out);
 266                         privmsg.SetSideEffect(true);
 267                         localtarget->Send(ServerInstance->GetRFCEvents().privmsg, privmsg);
 268                 }
 269
 270                 // Fire the post-message event.
 271                 return FirePostEvent(source, msgtarget, msgdetails);
 272         }
 273
 274  public:
 275         CommandMessage(Module* parent, MessageType mt)
 276                 : Command(parent, ClientProtocol::Messages::Privmsg::CommandStrFromMsgType(mt), 2, 2)
 277                 , msgtype(mt)
 278         {
 279                 syntax = "<target>[,<target>]+ :<message>";
 280         }
 281
 282         /** Handle command.
 283          * @param parameters The parameters to the command
 284          * @param user The user issuing the command
 285          * @return A value from CmdResult to indicate command success or failure.
 286          */
 287         CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
 288         {
 289                 if (CommandParser::LoopCall(user, this, parameters, 0))
 290                         return CMD_SUCCESS;
 291
 292                 // The specified message was empty.
 293                 if (parameters[1].empty())
 294                 {
 295                         user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
 296                         return CMD_FAILURE;
 297                 }
 298
 299                 // The target is a server glob.
 300                 if (parameters[0][0] == '$')
 301                         return HandleServerTarget(user, parameters);
 302
 303                 // If the message begins with a status character then look it up.
 304                 const char* target = parameters[0].c_str();
 305                 PrefixMode* pmh = ServerInstance->Modes->FindPrefix(target[0]);
 306                 if (pmh)
 307                         target++;
 308
 309                 // The target is a channel name.
 310                 if (*target == '#')
 311                         return HandleChannelTarget(user, parameters, target, pmh);
 312
 313                 // The target is a nickname.
 314                 return HandleUserTarget(user, parameters);
 315         }
 316
 317         RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
 318         {
 319                 if (IS_LOCAL(user))
 320                         // This is handled by the OnUserPostMessage hook to split the LoopCall pieces
 321                         return ROUTE_LOCALONLY;
 322                 else
 323                         return ROUTE_MESSAGE(parameters[0]);
 324         }
 325 };
 326
 327 class CommandSQuery : public SplitCommand
 328 {
 329  public:
 330         CommandSQuery(Module* Creator)
 331                 : SplitCommand(Creator, "SQUERY", 2, 2)
 332         {
 333                 syntax = "<service> :<message>";
 334         }
 335
 336         CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
 337         {
 338                 // The specified message was empty.
 339                 if (parameters[1].empty())
 340                 {
 341                         user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
 342                         return CMD_FAILURE;
 343                 }
 344
 345                 // The target can be either a nick or a nick@server mask.
 346                 User* target;
 347                 const char* targetserver = strchr(parameters[0].c_str(), '@');
 348                 if (targetserver)
 349                 {
 350                         // The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
 351                         target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
 352                         if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
 353                                 target = NULL;
 354                 }
 355                 else
 356                 {
 357                         // The targer can be on any server.
 358                         target = ServerInstance->FindNickOnly(parameters[0]);
 359                 }
 360
 361                 if (!target || target->registered != REG_ALL || !target->server->IsULine())
 362                 {
 363                         // The target user does not exist, is not fully registered, or is not a service.
 364                         user->WriteNumeric(ERR_NOSUCHSERVICE, parameters[0], "No such service");
 365                         return CMD_FAILURE;
 366                 }
 367
 368                 // Fire the pre-message events.
 369                 MessageTarget msgtarget(target);
 370                 MessageDetailsImpl msgdetails(MSG_PRIVMSG, parameters[1], parameters.GetTags());
 371                 if (!FirePreEvents(user, msgtarget, msgdetails))
 372                         return CMD_FAILURE;
 373
 374                 // The SQUERY command targets a service on a U-lined server. This can never
 375                 // be on the server local to the source so we don't need to do any routing
 376                 // logic and can forward it as a PRIVMSG.
 377
 378                 // Fire the post-message event.
 379                 return FirePostEvent(user, msgtarget, msgdetails);
 380         }
 381 };
 382
 383 class ModuleCoreMessage : public Module
 384 {
 385  private:
 386         CommandMessage cmdprivmsg;
 387         CommandMessage cmdnotice;
 388         CommandSQuery cmdsquery;
 389         ChanModeReference moderatedmode;
 390         ChanModeReference noextmsgmode;
 391
 392  public:
 393         ModuleCoreMessage()
 394                 : cmdprivmsg(this, MSG_PRIVMSG)
 395                 , cmdnotice(this, MSG_NOTICE)
 396                 , cmdsquery(this)
 397                 , moderatedmode(this, "moderated")
 398                 , noextmsgmode(this, "noextmsg")
 399         {
 400         }
 401
 402         ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
 403         {
 404                 if (!IS_LOCAL(user) || target.type != MessageTarget::TYPE_CHANNEL)
 405                         return MOD_RES_PASSTHRU;
 406
 407                 Channel* chan = target.Get<Channel>();
 408                 if (chan->IsModeSet(noextmsgmode) && !chan->HasUser(user))
 409                 {
 410                         // The noextmsg mode is set and the user is not in the channel.
 411                         user->WriteNumeric(Numerics::CannotSendTo(chan, "external messages", *noextmsgmode));
 412                         return MOD_RES_DENY;
 413                 }
 414
 415                 bool no_chan_priv = chan->GetPrefixValue(user) < VOICE_VALUE;
 416                 if (no_chan_priv && chan->IsModeSet(moderatedmode))
 417                 {
 418                         // The moderated mode is set and the user has no status rank.
 419                         user->WriteNumeric(Numerics::CannotSendTo(chan, "messages", *moderatedmode));
 420                         return MOD_RES_DENY;
 421                 }
 422
 423                 if (no_chan_priv && ServerInstance->Config->RestrictBannedUsers != ServerConfig::BUT_NORMAL && chan->IsBanned(user))
 424                 {
 425                         // The user is banned in the channel and restrictbannedusers is enabled.
 426                         if (ServerInstance->Config->RestrictBannedUsers == ServerConfig::BUT_RESTRICT_NOTIFY)
 427                                 user->WriteNumeric(Numerics::CannotSendTo(chan, "You cannot send messages to this channel whilst banned."));
 428                         return MOD_RES_DENY;
 429                 }
 430
 431                 return MOD_RES_PASSTHRU;
 432         }
 433
 434         Version GetVersion() CXX11_OVERRIDE
 435         {
 436                 return Version("Provides the NOTICE, PRIVMSG, and SQUERY commands", VF_CORE|VF_VENDOR);
 437         }
 438 };
 439
 440 MODULE_INIT(ModuleCoreMessage)