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/>.
27 ERR_NOSUCHSERVICE = 408
30 class MessageDetailsImpl : public MessageDetails
33 MessageDetailsImpl(MessageType mt, const std::string& msg, const ClientProtocol::TagMap& tags)
34 : MessageDetails(mt, msg, tags)
38 bool IsCTCP(std::string& name, std::string& body) const CXX11_OVERRIDE
43 size_t end_of_name = text.find(' ', 2);
44 size_t end_of_ctcp = *text.rbegin() == '\x1' ? 1 : 0;
45 if (end_of_name == std::string::npos)
47 // The CTCP only contains a name.
48 name.assign(text, 1, text.length() - 1 - end_of_ctcp);
53 // The CTCP contains a name and a body.
54 name.assign(text, 1, end_of_name - 1);
56 size_t start_of_body = text.find_first_not_of(' ', end_of_name + 1);
57 if (start_of_body == std::string::npos)
59 // The CTCP body is provided but empty.
64 // The CTCP body provided was non-empty.
65 body.assign(text, start_of_body, text.length() - start_of_body - end_of_ctcp);
69 bool IsCTCP(std::string& name) const CXX11_OVERRIDE
74 size_t end_of_name = text.find(' ', 2);
75 if (end_of_name == std::string::npos)
77 // The CTCP only contains a name.
78 size_t end_of_ctcp = *text.rbegin() == '\x1' ? 1 : 0;
79 name.assign(text, 1, text.length() - 1 - end_of_ctcp);
83 // The CTCP contains a name and a body.
84 name.assign(text, 1, end_of_name - 1);
88 bool IsCTCP() const CXX11_OVERRIDE
90 // According to draft-oakley-irc-ctcp-02 a valid CTCP must begin with SOH and
91 // contain at least one octet which is not NUL, SOH, CR, LF, or SPACE. As most
92 // of these are restricted at the protocol level we only need to check for SOH
94 return (text.length() >= 2) && (text[0] == '\x1') && (text[1] != '\x1') && (text[1] != ' ');
100 bool FirePreEvents(User* source, MessageTarget& msgtarget, MessageDetails& msgdetails)
102 // Inform modules that a message wants to be sent.
104 FIRST_MOD_RESULT(OnUserPreMessage, modres, (source, msgtarget, msgdetails));
105 if (modres == MOD_RES_DENY)
107 // Inform modules that a module blocked the mssage.
108 FOREACH_MOD(OnUserMessageBlocked, (source, msgtarget, msgdetails));
112 // Check whether a module zapped the message body.
113 if (msgdetails.text.empty())
115 source->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
119 // Inform modules that a message is about to be sent.
120 FOREACH_MOD(OnUserMessage, (source, msgtarget, msgdetails));
124 CmdResult FirePostEvent(User* source, const MessageTarget& msgtarget, const MessageDetails& msgdetails)
126 // If the source is local and was not sending a CTCP reply then update their idle time.
127 LocalUser* lsource = IS_LOCAL(source);
128 if (lsource && (msgdetails.type != MSG_NOTICE || !msgdetails.IsCTCP()))
129 lsource->idle_lastmsg = ServerInstance->Time();
131 // Inform modules that a message was sent.
132 FOREACH_MOD(OnUserPostMessage, (source, msgtarget, msgdetails));
137 class CommandMessage : public Command
140 const MessageType msgtype;
142 CmdResult HandleChannelTarget(User* source, const Params& parameters, const char* target, PrefixMode* pm)
144 Channel* chan = ServerInstance->FindChan(target);
147 // The target channel does not exist.
148 source->WriteNumeric(Numerics::NoSuchChannel(parameters[0]));
152 // Fire the pre-message events.
153 MessageTarget msgtarget(chan, pm ? pm->GetPrefix() : 0);
154 MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
155 msgdetails.exemptions.insert(source);
156 if (!FirePreEvents(source, msgtarget, msgdetails))
159 // Send the message to the members of the channel.
160 ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, source, chan, msgdetails.text, msgdetails.type, msgtarget.status);
161 privmsg.AddTags(msgdetails.tags_out);
162 privmsg.SetSideEffect(true);
163 chan->Write(ServerInstance->GetRFCEvents().privmsg, privmsg, msgtarget.status, msgdetails.exemptions);
165 // Create the outgoing message and message event.
166 return FirePostEvent(source, msgtarget, msgdetails);
169 CmdResult HandleServerTarget(User* source, const Params& parameters)
171 // If the source isn't allowed to mass message users then reject
172 // the attempt to mass-message users.
173 if (!source->HasPrivPermission("users/mass-message"))
176 // Extract the server glob match from the target parameter.
177 std::string servername(parameters[0], 1);
179 // Fire the pre-message events.
180 MessageTarget msgtarget(&servername);
181 MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
182 if (!FirePreEvents(source, msgtarget, msgdetails))
185 // If the current server name matches the server name glob then send
186 // the message out to the local users.
187 if (InspIRCd::Match(ServerInstance->Config->ServerName, servername))
189 // Create the outgoing message and message event.
190 ClientProtocol::Messages::Privmsg message(ClientProtocol::Messages::Privmsg::nocopy, source, "$*", msgdetails.text, msgdetails.type);
191 message.AddTags(msgdetails.tags_out);
192 message.SetSideEffect(true);
193 ClientProtocol::Event messageevent(ServerInstance->GetRFCEvents().privmsg, message);
195 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
196 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
198 LocalUser* luser = *i;
200 // Don't send to unregistered users or the user who is the source.
201 if (luser->registered != REG_ALL || luser == source)
204 // Only send to non-exempt users.
205 if (!msgdetails.exemptions.count(luser))
206 luser->Send(messageevent);
210 // Fire the post-message event.
211 return FirePostEvent(source, msgtarget, msgdetails);
214 CmdResult HandleUserTarget(User* source, const Params& parameters)
217 if (IS_LOCAL(source))
219 // Local sources can specify either a nick or a nick@server mask as the target.
220 const char* targetserver = strchr(parameters[0].c_str(), '@');
223 // The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
224 target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
225 if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
230 // If the source is a local user then we only look up the target by nick.
231 target = ServerInstance->FindNickOnly(parameters[0]);
236 // Remote users can only specify a nick or UUID as the target.
237 target = ServerInstance->FindNick(parameters[0]);
240 if (!target || target->registered != REG_ALL)
242 // The target user does not exist or is not fully registered.
243 source->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
247 // If the target is away then inform the user.
248 if (target->IsAway() && msgtype == MSG_PRIVMSG)
249 source->WriteNumeric(RPL_AWAY, target->nick, target->awaymsg);
251 // Fire the pre-message events.
252 MessageTarget msgtarget(target);
253 MessageDetailsImpl msgdetails(msgtype, parameters[1], parameters.GetTags());
254 if (!FirePreEvents(source, msgtarget, msgdetails))
257 LocalUser* const localtarget = IS_LOCAL(target);
260 // Send to the target if they are a local user.
261 ClientProtocol::Messages::Privmsg privmsg(ClientProtocol::Messages::Privmsg::nocopy, source, localtarget->nick, msgdetails.text, msgtype);
262 privmsg.AddTags(msgdetails.tags_out);
263 privmsg.SetSideEffect(true);
264 localtarget->Send(ServerInstance->GetRFCEvents().privmsg, privmsg);
267 // Fire the post-message event.
268 return FirePostEvent(source, msgtarget, msgdetails);
272 CommandMessage(Module* parent, MessageType mt)
273 : Command(parent, ClientProtocol::Messages::Privmsg::CommandStrFromMsgType(mt), 2, 2)
276 syntax = "<target>[,<target>]+ :<message>";
280 * @param parameters The parameters to the command
281 * @param user The user issuing the command
282 * @return A value from CmdResult to indicate command success or failure.
284 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
286 if (CommandParser::LoopCall(user, this, parameters, 0))
289 // The specified message was empty.
290 if (parameters[1].empty())
292 user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
296 // The target is a server glob.
297 if (parameters[0][0] == '$')
298 return HandleServerTarget(user, parameters);
300 // If the message begins with a status character then look it up.
301 const char* target = parameters[0].c_str();
302 PrefixMode* pmh = ServerInstance->Modes->FindPrefix(target[0]);
306 // The target is a channel name.
308 return HandleChannelTarget(user, parameters, target, pmh);
310 // The target is a nickname.
311 return HandleUserTarget(user, parameters);
314 RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
317 // This is handled by the OnUserPostMessage hook to split the LoopCall pieces
318 return ROUTE_LOCALONLY;
320 return ROUTE_MESSAGE(parameters[0]);
324 class CommandSQuery : public SplitCommand
327 CommandSQuery(Module* Creator)
328 : SplitCommand(Creator, "SQUERY", 2, 2)
330 syntax = "<service> :<message>";
333 CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
335 // The specified message was empty.
336 if (parameters[1].empty())
338 user->WriteNumeric(ERR_NOTEXTTOSEND, "No text to send");
342 // The target can be either a nick or a nick@server mask.
344 const char* targetserver = strchr(parameters[0].c_str(), '@');
347 // The target is a user on a specific server (e.g. jto@tolsun.oulu.fi).
348 target = ServerInstance->FindNickOnly(parameters[0].substr(0, targetserver - parameters[0].c_str()));
349 if (target && strcasecmp(target->server->GetName().c_str(), targetserver + 1))
354 // The targer can be on any server.
355 target = ServerInstance->FindNickOnly(parameters[0]);
358 if (!target || target->registered != REG_ALL || !target->server->IsULine())
360 // The target user does not exist, is not fully registered, or is not a service.
361 user->WriteNumeric(ERR_NOSUCHSERVICE, parameters[0], "No such service");
365 // Fire the pre-message events.
366 MessageTarget msgtarget(target);
367 MessageDetailsImpl msgdetails(MSG_PRIVMSG, parameters[1], parameters.GetTags());
368 if (!FirePreEvents(user, msgtarget, msgdetails))
371 // The SQUERY command targets a service on a U-lined server. This can never
372 // be on the server local to the source so we don't need to do any routing
373 // logic and can forward it as a PRIVMSG.
375 // Fire the post-message event.
376 return FirePostEvent(user, msgtarget, msgdetails);
380 class ModuleCoreMessage : public Module
383 CommandMessage cmdprivmsg;
384 CommandMessage cmdnotice;
385 CommandSQuery cmdsquery;
386 ChanModeReference moderatedmode;
387 ChanModeReference noextmsgmode;
391 : cmdprivmsg(this, MSG_PRIVMSG)
392 , cmdnotice(this, MSG_NOTICE)
394 , moderatedmode(this, "moderated")
395 , noextmsgmode(this, "noextmsg")
399 ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
401 if (!IS_LOCAL(user) || target.type != MessageTarget::TYPE_CHANNEL)
402 return MOD_RES_PASSTHRU;
404 Channel* chan = target.Get<Channel>();
405 if (chan->IsModeSet(noextmsgmode) && !chan->HasUser(user))
407 // The noextmsg mode is set and the user is not in the channel.
408 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (no external messages)");
412 bool no_chan_priv = chan->GetPrefixValue(user) < VOICE_VALUE;
413 if (no_chan_priv && chan->IsModeSet(moderatedmode))
415 // The moderated mode is set and the user has no status rank.
416 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (+m is set)");
420 if (no_chan_priv && ServerInstance->Config->RestrictBannedUsers != ServerConfig::BUT_NORMAL && chan->IsBanned(user))
422 // The user is banned in the channel and restrictbannedusers is enabled.
423 if (ServerInstance->Config->RestrictBannedUsers == ServerConfig::BUT_RESTRICT_NOTIFY)
424 user->WriteNumeric(ERR_CANNOTSENDTOCHAN, chan->name, "Cannot send to channel (you're banned)");
428 return MOD_RES_PASSTHRU;
431 Version GetVersion() CXX11_OVERRIDE
433 return Version("Provides the NOTICE, PRIVMSG, and SQUERY commands", VF_CORE|VF_VENDOR);
437 MODULE_INIT(ModuleCoreMessage)