/*
* InspIRCd -- Internet Relay Chat Daemon
*
+ * Copyright (C) 2017-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013, 2017-2018 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
- * Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
- * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2007, 2010 Craig Edwards <brain@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
#include "inspircd.h"
+enum
+{
+ // From RFC 2812.
+ ERR_NOSUCHSERVICE = 408
+};
+
class MessageDetailsImpl : public MessageDetails
{
public:
}
};
-class MessageCommandBase : public Command
+namespace
{
- ChanModeReference moderatedmode;
- ChanModeReference noextmsgmode;
-
- /** Send a PRIVMSG or NOTICE message to all local users from the given user
- * @param source The user sending the message.
- * @param msg The details of the message to send.
- */
- static void SendAll(User* source, const MessageDetails& details)
+ bool FirePreEvents(User* source, MessageTarget& msgtarget, MessageDetails& msgdetails)
{
- ClientProtocol::Messages::Privmsg message(ClientProtocol::Messages::Privmsg::nocopy, source, "$*", details.text, details.type);
- message.AddTags(details.tags_out);
- message.SetSideEffect(true);
- ClientProtocol::Event messageevent(ServerInstance->GetRFCEvents().privmsg, message);
+ // Inform modules that a message wants to be sent.
+ ModResult modres;
+ FIRST_MOD_RESULT(OnUserPreMessage, modres, (source, msgtarget, msgdetails));
+ if (modres == MOD_RES_DENY)
+ {
+ // Inform modules that a module blocked the mssage.
+ FOREACH_MOD(OnUserMessageBlocked, (source, msgtarget, msgdetails));
+ return false;
+ }
- const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
- for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
+ // Check whether a module zapped the message body.
+ if (msgdetails.text.empty())
{
- LocalUser* user = *i;
- if ((user->registered == REG_ALL) && (!details.exemptions.count(user)))
- user->Send(messageevent);
+ source->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
+ return false;
}
- }
- public:
- MessageCommandBase(Module* parent, MessageType mt)
- : Command(parent, ClientProtocol::Messages::Privmsg::CommandStrFromMsgType(mt), 2, 2)
- , moderatedmode(parent, "moderated")
- , noextmsgmode(parent, "noextmsg")
- {
- syntax = "<target>{,<target>} <message>";
+ // Inform modules that a message is about to be sent.
+ FOREACH_MOD(OnUserMessage, (source, msgtarget, msgdetails));
+ return true;
}
- /** Handle command.
- * @param parameters The parameters to the command
- * @param user The user issuing the command
- * @return A value from CmdResult to indicate command success or failure.
- */
- CmdResult HandleMessage(User* user, const Params& parameters, MessageType mt);
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
+ CmdResult FirePostEvent(User* source, const MessageTarget& msgtarget, const MessageDetails& msgdetails)
{
- if (IS_LOCAL(user))
- // This is handled by the OnUserPostMessage hook to split the LoopCall pieces
- return ROUTE_LOCALONLY;
- else
- return ROUTE_MESSAGE(parameters[0]);
+ // If the source is local and was not sending a CTCP reply then update their idle time.
+ LocalUser* lsource = IS_LOCAL(source);
+ if (lsource && msgdetails.update_idle && (msgdetails.type != MSG_NOTICE || !msgdetails.IsCTCP()))
+ lsource->idle_lastmsg = ServerInstance->Time();
+
+ // Inform modules that a message was sent.
+ FOREACH_MOD(OnUserPostMessage, (source, msgtarget, msgdetails));
+ return CMD_SUCCESS;
}
-};
+}
-CmdResult MessageCommandBase::HandleMessage(User* user, const Params& parameters, MessageType mt)
+class CommandMessage : public Command
{
- User *dest;
- Channel *chan;
-
- if (CommandParser::LoopCall(user, this, parameters, 0))
- return CMD_SUCCESS;
+ private:
+ const MessageType msgtype;
- if (parameters[0][0] == '$')
+ CmdResult HandleChannelTarget(User* source, const Params& parameters, const char* target, PrefixMode* pm)
{
- if (!user->HasPrivPermission("users/mass-message"))
- return CMD_SUCCESS;
-
- std::string servername(parameters[0], 1);
- MessageTarget msgtarget(&servername);
- MessageDetailsImpl msgdetails(mt, parameters[1], parameters.GetTags());
-
- ModResult MOD_RESULT;
- FIRST_MOD_RESULT(OnUserPreMessage, MOD_RESULT, (user, msgtarget, msgdetails));
- if (MOD_RESULT == MOD_RES_DENY)
+ Channel* chan = ServerInstance->FindChan(target);
+ if (!chan)
{
- FOREACH_MOD(OnUserMessageBlocked, (user, msgtarget, msgdetails));
+ // The target channel does not exist.
+ source->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
return CMD_FAILURE;
}
- FOREACH_MOD(OnUserMessage, (user, msgtarget, msgdetails));
- if (InspIRCd::Match(ServerInstance->Config->ServerName, servername, NULL))
- {
- SendAll(user, msgdetails);
- }
- FOREACH_MOD(OnUserPostMessage, (user, msgtarget, msgdetails));
- return CMD_SUCCESS;
- }
+ // Fire the pre-message events.
+ MessageTarget msgtarget(chan, pm ? pm->GetPrefix() : 0);
+ MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
+ msgdetails.exemptions.insert(source);
+ if (!FirePreEvents(source, msgtarget, msgdetails))
+ return CMD_FAILURE;
- char status = 0;
- const char* target = parameters[0].c_str();
+ // Send the message to the members of the channel.
+ ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, source, chan, msgdetails.text, msgdetails.type, msgtarget.status);
+ privmsg.AddTags(msgdetails.tags_out);
+ privmsg.SetSideEffect(true);
+ chan->Write(ServerInstance->GetRFCEvents().privmsg, privmsg, msgtarget.status, msgdetails.exemptions);
- if (ServerInstance->Modes->FindPrefix(*target))
- {
- status = *target;
- target++;
+ // Create the outgoing message and message event.
+ return FirePostEvent(source, msgtarget, msgdetails);
}
- if (*target == '#')
- {
- chan = ServerInstance->FindChan(target);
- if (chan)
+ CmdResult HandleServerTarget(User* source, const Params& parameters)
+ {
+ // If the source isn't allowed to mass message users then reject
+ // the attempt to mass-message users.
+ if (!source->HasPrivPermission("users/mass-message"))
{
- if (IS_LOCAL(user) && chan->GetPrefixValue(user) < VOICE_VALUE)
- {
- if (chan->IsModeSet(noextmsgmode) && !chan->HasUser(user))
- {
- user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (no external messages)");
- return CMD_FAILURE;
- }
-
- if (chan->IsModeSet(moderatedmode))
- {
- user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (+m)");
- return CMD_FAILURE;
- }
-
- if (ServerInstance->Config->RestrictBannedUsers != ServerConfig::BUT_NORMAL)
- {
- if (chan->IsBanned(user))
- {
- if (ServerInstance->Config->RestrictBannedUsers == ServerConfig::BUT_RESTRICT_NOTIFY)
- user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (you're banned)");
- return CMD_FAILURE;
- }
- }
- }
+ source->WriteNumeric(ERR_NOPRIVILEGES, "Permission Denied - You do not have the required operator privileges");
+ return CMD_FAILURE;
+ }
- MessageTarget msgtarget(chan, status);
- MessageDetailsImpl msgdetails(mt, parameters[1], parameters.GetTags());
- msgdetails.exemptions.insert(user);
+ // Extract the server glob match from the target parameter.
+ std::string servername(parameters[0], 1);
- ModResult MOD_RESULT;
- FIRST_MOD_RESULT(OnUserPreMessage, MOD_RESULT, (user, msgtarget, msgdetails));
- if (MOD_RESULT == MOD_RES_DENY)
- {
- FOREACH_MOD(OnUserMessageBlocked, (user, msgtarget, msgdetails));
- return CMD_FAILURE;
- }
+ // Fire the pre-message events.
+ MessageTarget msgtarget(&servername);
+ MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
+ if (!FirePreEvents(source, msgtarget, msgdetails))
+ return CMD_FAILURE;
- /* Check again, a module may have zapped the input string */
- if (msgdetails.text.empty())
+ // If the current server name matches the server name glob then send
+ // the message out to the local users.
+ if (InspIRCd::Match(ServerInstance->Config->ServerName, servername))
+ {
+ // Create the outgoing message and message event.
+ ClientProtocol::Messages::Privmsg message(ClientProtocol::Messages::Privmsg::nocopy, source, "$*", msgdetails.text, msgdetails.type);
+ message.AddTags(msgdetails.tags_out);
+ message.SetSideEffect(true);
+ ClientProtocol::Event messageevent(ServerInstance->GetRFCEvents().privmsg, message);
+
+ const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
+ for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
{
- user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
- return CMD_FAILURE;
- }
+ LocalUser* luser = *i;
- FOREACH_MOD(OnUserMessage, (user, msgtarget, msgdetails));
+ // Don't send to unregistered users or the user who is the source.
+ if (luser->registered != REG_ALL || luser == source)
+ continue;
- ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, user, chan, msgdetails.text, msgdetails.type, msgtarget.status);
- privmsg.AddTags(msgdetails.tags_out);
- privmsg.SetSideEffect(true);
- chan->Write(ServerInstance->GetRFCEvents().privmsg, privmsg, msgtarget.status, msgdetails.exemptions);
-
- FOREACH_MOD(OnUserPostMessage, (user, msgtarget, msgdetails));
- }
- else
- {
- /* channel does not exist */
- user->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
- return CMD_FAILURE;
+ // Only send to non-exempt users.
+ if (!msgdetails.exemptions.count(luser))
+ luser->Send(messageevent);
+ }
}
- return CMD_SUCCESS;
- }
- const char* destnick = parameters[0].c_str();
+ // Fire the post-message event.
+ return FirePostEvent(source, msgtarget, msgdetails);
+ }
- if (IS_LOCAL(user))
+ CmdResult HandleUserTarget(User* source, const Params& parameters)
{
- const char* targetserver = strchr(destnick, '@');
-
- if (targetserver)
+ User* target;
+ if (IS_LOCAL(source))
{
- std::string nickonly;
-
- nickonly.assign(destnick, 0, targetserver - destnick);
- dest = ServerInstance->FindNickOnly(nickonly);
- if (dest && strcasecmp(dest->server->GetName().c_str(), targetserver + 1))
+ // Local sources can specify either a nick or a nick@server mask as the target.
+ const char* targetserver = strchr(parameters[0].c_str(), '@');
+ if (targetserver)
+ {
+ // The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
+ target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
+ if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
+ target = NULL;
+ }
+ else
{
- /* Incorrect server for user */
- user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
- return CMD_FAILURE;
+ // If the source is a local user then we only look up the target by nick.
+ target = ServerInstance->FindNickOnly(parameters[0]);
}
}
else
- dest = ServerInstance->FindNickOnly(destnick);
- }
- else
- dest = ServerInstance->FindNick(destnick);
-
- if ((dest) && (dest->registered == REG_ALL))
- {
- if (parameters[1].empty())
{
- user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
- return CMD_FAILURE;
+ // Remote users can only specify a nick or UUID as the target.
+ target = ServerInstance->FindNick(parameters[0]);
}
- if ((dest->IsAway()) && (mt == MSG_PRIVMSG))
+ if (!target || target->registered != REG_ALL)
{
- /* auto respond with aweh msg */
- user->WriteNumeric(RPL_AWAY, dest->nick, dest->awaymsg);
+ // The target user does not exist or is not fully registered.
+ source->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
+ return CMD_FAILURE;
}
- MessageTarget msgtarget(dest);
- MessageDetailsImpl msgdetails(mt, parameters[1], parameters.GetTags());
-
-
- ModResult MOD_RESULT;
- FIRST_MOD_RESULT(OnUserPreMessage, MOD_RESULT, (user, msgtarget, msgdetails));
- if (MOD_RESULT == MOD_RES_DENY)
- {
- FOREACH_MOD(OnUserMessageBlocked, (user, msgtarget, msgdetails));
+ // Fire the pre-message events.
+ MessageTarget msgtarget(target);
+ MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
+ if (!FirePreEvents(source, msgtarget, msgdetails))
return CMD_FAILURE;
- }
- FOREACH_MOD(OnUserMessage, (user, msgtarget, msgdetails));
+ // If the target is away then inform the user.
+ if (target->IsAway() && msgdetails.type == MSG_PRIVMSG)
+ source->WriteNumeric(RPL_AWAY, target->nick, target->awaymsg);
- LocalUser* const localtarget = IS_LOCAL(dest);
+ LocalUser* const localtarget = IS_LOCAL(target);
if (localtarget)
{
- // direct write, same server
- ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, user, localtarget->nick, msgdetails.text, mt);
+ // Send to the target if they are a local user.
+ ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, source, localtarget->nick, msgdetails.text, msgdetails.type);
privmsg.AddTags(msgdetails.tags_out);
privmsg.SetSideEffect(true);
localtarget->Send(ServerInstance->GetRFCEvents().privmsg, privmsg);
}
- FOREACH_MOD(OnUserPostMessage, (user, msgtarget, msgdetails));
+ // Fire the post-message event.
+ return FirePostEvent(source, msgtarget, msgdetails);
}
- else
+
+ public:
+ CommandMessage(Module* parent, MessageType mt)
+ : Command(parent, ClientProtocol::Messages::Privmsg::CommandStrFromMsgType(mt), 2, 2)
+ , msgtype(mt)
{
- /* no such nick/channel */
- user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
- return CMD_FAILURE;
+ syntax = "<target>[,<target>]+ :<message>";
}
- return CMD_SUCCESS;
-}
-template<MessageType MT>
-class CommandMessage : public MessageCommandBase
+ /** Handle command.
+ * @param parameters The parameters to the command
+ * @param user The user issuing the command
+ * @return A value from CmdResult to indicate command success or failure.
+ */
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ if (CommandParser::LoopCall(user, this, parameters, 0))
+ return CMD_SUCCESS;
+
+ // The specified message was empty.
+ if (parameters[1].empty())
+ {
+ user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
+ return CMD_FAILURE;
+ }
+
+ // The target is a server glob.
+ if (parameters[0][0] == '$')
+ return HandleServerTarget(user, parameters);
+
+ // If the message begins with a status character then look it up.
+ const char* target = parameters[0].c_str();
+ PrefixMode* pmh = ServerInstance->Modes->FindPrefix(target[0]);
+ if (pmh)
+ target++;
+
+ // The target is a channel name.
+ if (*target == '#')
+ return HandleChannelTarget(user, parameters, target, pmh);
+
+ // The target is a nickname.
+ return HandleUserTarget(user, parameters);
+ }
+
+ RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ if (IS_LOCAL(user))
+ // This is handled by the OnUserPostMessage hook to split the LoopCall pieces
+ return ROUTE_LOCALONLY;
+ else
+ return ROUTE_MESSAGE(parameters[0]);
+ }
+};
+
+class CommandSQuery : public SplitCommand
{
public:
- CommandMessage(Module* parent)
- : MessageCommandBase(parent, MT)
+ CommandSQuery(Module* Creator)
+ : SplitCommand(Creator, "SQUERY", 2, 2)
{
+ syntax = "<service> :<message>";
}
- CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
+ CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
{
- return HandleMessage(user, parameters, MT);
+ // The specified message was empty.
+ if (parameters[1].empty())
+ {
+ user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
+ return CMD_FAILURE;
+ }
+
+ // The target can be either a nick or a nick@server mask.
+ User* target;
+ const char* targetserver = strchr(parameters[0].c_str(), '@');
+ if (targetserver)
+ {
+ // The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
+ target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
+ if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
+ target = NULL;
+ }
+ else
+ {
+ // The targer can be on any server.
+ target = ServerInstance->FindNickOnly(parameters[0]);
+ }
+
+ if (!target || target->registered != REG_ALL || !target->server->IsULine())
+ {
+ // The target user does not exist, is not fully registered, or is not a service.
+ user->WriteNumeric(ERR_NOSUCHSERVICE, parameters[0], "No such service");
+ return CMD_FAILURE;
+ }
+
+ // Fire the pre-message events.
+ MessageTarget msgtarget(target);
+ MessageDetailsImpl msgdetails(MSG_PRIVMSG, parameters[1], parameters.GetTags());
+ if (!FirePreEvents(user, msgtarget, msgdetails))
+ return CMD_FAILURE;
+
+ // The SQUERY command targets a service on a U-lined server. This can never
+ // be on the server local to the source so we don't need to do any routing
+ // logic and can forward it as a PRIVMSG.
+
+ // Fire the post-message event.
+ return FirePostEvent(user, msgtarget, msgdetails);
}
};
class ModuleCoreMessage : public Module
{
- CommandMessage<MSG_PRIVMSG> CommandPrivmsg;
- CommandMessage<MSG_NOTICE> CommandNotice;
+ private:
+ CommandMessage cmdprivmsg;
+ CommandMessage cmdnotice;
+ CommandSQuery cmdsquery;
+ ChanModeReference moderatedmode;
+ ChanModeReference noextmsgmode;
public:
ModuleCoreMessage()
- : CommandPrivmsg(this), CommandNotice(this)
+ : cmdprivmsg(this, MSG_PRIVMSG)
+ , cmdnotice(this, MSG_NOTICE)
+ , cmdsquery(this)
+ , moderatedmode(this, "moderated")
+ , noextmsgmode(this, "noextmsg")
{
}
- void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
+ ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
{
- // We only handle the idle times of local users.
- LocalUser* luser = IS_LOCAL(user);
- if (!luser)
- return;
+ if (!IS_LOCAL(user) || target.type != MessageTarget::TYPE_CHANNEL)
+ return MOD_RES_PASSTHRU;
- // We don't update the idle time when a CTCP reply is sent.
- if (details.type == MSG_NOTICE && details.IsCTCP())
- return;
+ Channel* chan = target.Get<Channel>();
+ if (chan->IsModeSet(noextmsgmode) && !chan->HasUser(user))
+ {
+ // The noextmsg mode is set and the user is not in the channel.
+ user->WriteNumeric(Numerics::CannotSendTo(chan, "external messages", *noextmsgmode));
+ return MOD_RES_DENY;
+ }
+
+ bool no_chan_priv = chan->GetPrefixValue(user) < VOICE_VALUE;
+ if (no_chan_priv && chan->IsModeSet(moderatedmode))
+ {
+ // The moderated mode is set and the user has no status rank.
+ user->WriteNumeric(Numerics::CannotSendTo(chan, "messages", *moderatedmode));
+ return MOD_RES_DENY;
+ }
+
+ if (no_chan_priv && ServerInstance->Config->RestrictBannedUsers != ServerConfig::BUT_NORMAL && chan->IsBanned(user))
+ {
+ // The user is banned in the channel and restrictbannedusers is enabled.
+ if (ServerInstance->Config->RestrictBannedUsers == ServerConfig::BUT_RESTRICT_NOTIFY)
+ user->WriteNumeric(Numerics::CannotSendTo(chan, "You cannot send messages to this channel whilst banned."));
+ return MOD_RES_DENY;
+ }
- luser->idle_lastmsg = ServerInstance->Time();
+ return MOD_RES_PASSTHRU;
}
Version GetVersion() CXX11_OVERRIDE
{
- return Version("PRIVMSG, NOTICE", VF_CORE|VF_VENDOR);
+ return Version("Provides the NOTICE, PRIVMSG, and SQUERY commands", VF_CORE|VF_VENDOR);
}
};
projects / user / henk / code / inspircd.git / blobdiff