2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
6 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
8 * This file is part of InspIRCd. InspIRCd is free software: you can
9 * redistribute it and/or modify it under the terms of the GNU General Public
10 * License as published by the Free Software Foundation, version 2.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class MessageDetailsImpl : public MessageDetails
27 MessageDetailsImpl(MessageType mt, const std::string& msg, const ClientProtocol::TagMap& tags)
28 : MessageDetails(mt, msg, tags)
32 bool IsCTCP(std::string& name, std::string& body) const CXX11_OVERRIDE
37 size_t end_of_name = text.find(' ', 2);
38 size_t end_of_ctcp = *text.rbegin() == '\x1' ? 1 : 0;
39 if (end_of_name == std::string::npos)
41 // The CTCP only contains a name.
42 name.assign(text, 1, text.length() - 1 - end_of_ctcp);
47 // The CTCP contains a name and a body.
48 name.assign(text, 1, end_of_name - 1);
50 size_t start_of_body = text.find_first_not_of(' ', end_of_name + 1);
51 if (start_of_body == std::string::npos)
53 // The CTCP body is provided but empty.
58 // The CTCP body provided was non-empty.
59 body.assign(text, start_of_body, text.length() - start_of_body - end_of_ctcp);
63 bool IsCTCP(std::string& name) const CXX11_OVERRIDE
68 size_t end_of_name = text.find(' ', 2);
69 if (end_of_name == std::string::npos)
71 // The CTCP only contains a name.
72 size_t end_of_ctcp = *text.rbegin() == '\x1' ? 1 : 0;
73 name.assign(text, 1, text.length() - 1 - end_of_ctcp);
77 // The CTCP contains a name and a body.
78 name.assign(text, 1, end_of_name - 1);
82 bool IsCTCP() const CXX11_OVERRIDE
84 // According to draft-oakley-irc-ctcp-02 a valid CTCP must begin with SOH and
85 // contain at least one octet which is not NUL, SOH, CR, LF, or SPACE. As most
86 // of these are restricted at the protocol level we only need to check for SOH
88 return (text.length() >= 2) && (text[0] == '\x1') && (text[1] != '\x1') && (text[1] != ' ');
92 class MessageCommandBase : public Command
94 ChanModeReference moderatedmode;
95 ChanModeReference noextmsgmode;
97 /** Send a PRIVMSG or NOTICE message to all local users from the given user
98 * @param user User sending the message
99 * @param msg The message to send
100 * @param mt Type of the message (MSG_PRIVMSG or MSG_NOTICE)
101 * @param tags Message tags to include in the outgoing protocol message
103 static void SendAll(User* user, const std::string& msg, MessageType mt, const ClientProtocol::TagMap& tags);
106 MessageCommandBase(Module* parent, MessageType mt)
107 : Command(parent, ClientProtocol::Messages::Privmsg::CommandStrFromMsgType(mt), 2, 2)
108 , moderatedmode(parent, "moderated")
109 , noextmsgmode(parent, "noextmsg")
111 syntax = "<target>{,<target>} <message>";
115 * @param parameters The parameters to the command
116 * @param user The user issuing the command
117 * @return A value from CmdResult to indicate command success or failure.
119 CmdResult HandleMessage(User* user, const Params& parameters, MessageType mt);
121 RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
124 // This is handled by the OnUserPostMessage hook to split the LoopCall pieces
125 return ROUTE_LOCALONLY;
127 return ROUTE_MESSAGE(parameters[0]);
131 void MessageCommandBase::SendAll(User* user, const std::string& msg, MessageType mt, const ClientProtocol::TagMap& tags)
133 ClientProtocol::Messages::Privmsg message(ClientProtocol::Messages::Privmsg::nocopy, user, "$*", msg, mt);
134 message.AddTags(tags);
135 message.SetSideEffect(true);
136 ClientProtocol::Event messageevent(ServerInstance->GetRFCEvents().privmsg, message);
138 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
139 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
141 if ((*i)->registered == REG_ALL)
142 (*i)->Send(messageevent);
146 CmdResult MessageCommandBase::HandleMessage(User* user, const Params& parameters, MessageType mt)
151 if (CommandParser::LoopCall(user, this, parameters, 0))
154 if (parameters[0][0] == '$')
156 if (!user->HasPrivPermission("users/mass-message"))
159 std::string servername(parameters[0], 1);
160 MessageTarget msgtarget(&servername);
161 MessageDetailsImpl msgdetails(mt, parameters[1], parameters.GetTags());
163 ModResult MOD_RESULT;
164 FIRST_MOD_RESULT(OnUserPreMessage, MOD_RESULT, (user, msgtarget, msgdetails));
165 if (MOD_RESULT == MOD_RES_DENY)
167 FOREACH_MOD(OnUserMessageBlocked, (user, msgtarget, msgdetails));
171 FOREACH_MOD(OnUserMessage, (user, msgtarget, msgdetails));
172 if (InspIRCd::Match(ServerInstance->Config->ServerName, servername, NULL))
174 SendAll(user, msgdetails.text, mt, msgdetails.tags_out);
176 FOREACH_MOD(OnUserPostMessage, (user, msgtarget, msgdetails));
181 const char* target = parameters[0].c_str();
183 if (ServerInstance->Modes->FindPrefix(*target))
190 chan = ServerInstance->FindChan(target);
194 if (IS_LOCAL(user) && chan->GetPrefixValue(user) < VOICE_VALUE)
196 if (chan->IsModeSet(noextmsgmode) && !chan->HasUser(user))
198 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (no external messages)");
202 if (chan->IsModeSet(moderatedmode))
204 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (+m)");
208 if (ServerInstance->Config->RestrictBannedUsers != ServerConfig::BUT_NORMAL)
210 if (chan->IsBanned(user))
212 if (ServerInstance->Config->RestrictBannedUsers == ServerConfig::BUT_RESTRICT_NOTIFY)
213 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (you're banned)");
219 MessageTarget msgtarget(chan, status);
220 MessageDetailsImpl msgdetails(mt, parameters[1], parameters.GetTags());
221 msgdetails.exemptions.insert(user);
223 ModResult MOD_RESULT;
224 FIRST_MOD_RESULT(OnUserPreMessage, MOD_RESULT, (user, msgtarget, msgdetails));
225 if (MOD_RESULT == MOD_RES_DENY)
227 FOREACH_MOD(OnUserMessageBlocked, (user, msgtarget, msgdetails));
231 /* Check again, a module may have zapped the input string */
232 if (msgdetails.text.empty())
234 user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
238 FOREACH_MOD(OnUserMessage, (user, msgtarget, msgdetails));
240 ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, user, chan, msgdetails.text, msgdetails.type, msgtarget.status);
241 privmsg.AddTags(msgdetails.tags_out);
242 privmsg.SetSideEffect(true);
243 chan->Write(ServerInstance->GetRFCEvents().privmsg, privmsg, msgtarget.status, msgdetails.exemptions);
245 FOREACH_MOD(OnUserPostMessage, (user, msgtarget, msgdetails));
249 /* channel does not exist */
250 user->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
256 const char* destnick = parameters[0].c_str();
260 const char* targetserver = strchr(destnick, '@');
264 std::string nickonly;
266 nickonly.assign(destnick, 0, targetserver - destnick);
267 dest = ServerInstance->FindNickOnly(nickonly);
268 if (dest && strcasecmp(dest->server->GetName().c_str(), targetserver + 1))
270 /* Incorrect server for user */
271 user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
276 dest = ServerInstance->FindNickOnly(destnick);
279 dest = ServerInstance->FindNick(destnick);
281 if ((dest) && (dest->registered == REG_ALL))
283 if (parameters[1].empty())
285 user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
289 if ((dest->IsAway()) && (mt == MSG_PRIVMSG))
291 /* auto respond with aweh msg */
292 user->WriteNumeric(RPL_AWAY, dest->nick, dest->awaymsg);
295 MessageTarget msgtarget(dest);
296 MessageDetailsImpl msgdetails(mt, parameters[1], parameters.GetTags());
299 ModResult MOD_RESULT;
300 FIRST_MOD_RESULT(OnUserPreMessage, MOD_RESULT, (user, msgtarget, msgdetails));
301 if (MOD_RESULT == MOD_RES_DENY)
303 FOREACH_MOD(OnUserMessageBlocked, (user, msgtarget, msgdetails));
307 FOREACH_MOD(OnUserMessage, (user, msgtarget, msgdetails));
309 LocalUser* const localtarget = IS_LOCAL(dest);
312 // direct write, same server
313 ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, user, localtarget->nick, msgdetails.text, mt);
314 privmsg.AddTags(msgdetails.tags_out);
315 privmsg.SetSideEffect(true);
316 localtarget->Send(ServerInstance->GetRFCEvents().privmsg, privmsg);
319 FOREACH_MOD(OnUserPostMessage, (user, msgtarget, msgdetails));
323 /* no such nick/channel */
324 user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
330 template<MessageType MT>
331 class CommandMessage : public MessageCommandBase
334 CommandMessage(Module* parent)
335 : MessageCommandBase(parent, MT)
339 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
341 return HandleMessage(user, parameters, MT);
345 class ModuleCoreMessage : public Module
347 CommandMessage<MSG_PRIVMSG> CommandPrivmsg;
348 CommandMessage<MSG_NOTICE> CommandNotice;
352 : CommandPrivmsg(this), CommandNotice(this)
356 void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE
358 // We only handle the idle times of local users.
359 LocalUser* luser = IS_LOCAL(user);
363 // We don't update the idle time when a CTCP reply is sent.
364 if (details.type == MSG_NOTICE && details.IsCTCP())
367 luser->idle_lastmsg = ServerInstance->Time();
370 Version GetVersion() CXX11_OVERRIDE
372 return Version("PRIVMSG, NOTICE", VF_CORE|VF_VENDOR);
376 MODULE_INIT(ModuleCoreMessage)