2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2014-2015 Attila Molnar <attilamolnar@hush.com>
6 * This file is part of InspIRCd. InspIRCd is free software: you can
7 * redistribute it and/or modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation, version 2.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "core_channel.h"
25 class CoreModChannel : public Module, public CheckExemption::EventListener
27 Invite::APIImpl invapi;
28 CommandInvite cmdinvite;
31 CommandNames cmdnames;
32 CommandTopic cmdtopic;
34 ModeChannelBan banmode;
35 SimpleChannelModeHandler inviteonlymode;
36 ModeChannelKey keymode;
37 ModeChannelLimit limitmode;
38 SimpleChannelModeHandler moderatedmode;
39 SimpleChannelModeHandler noextmsgmode;
41 SimpleChannelModeHandler privatemode;
42 SimpleChannelModeHandler secretmode;
43 SimpleChannelModeHandler topiclockmode;
44 ModeChannelVoice voicemode;
46 insp::flat_map<std::string, char> exemptions;
48 ModResult IsInvited(User* user, Channel* chan)
50 LocalUser* localuser = IS_LOCAL(user);
51 if ((localuser) && (invapi.IsInvited(localuser, chan)))
53 return MOD_RES_PASSTHRU;
58 : CheckExemption::EventListener(this)
60 , cmdinvite(this, invapi)
66 , inviteonlymode(this, "inviteonly", 'i')
69 , moderatedmode(this, "moderated", 'm')
70 , noextmsgmode(this, "noextmsg", 'n')
72 , privatemode(this, "private", 'p')
73 , secretmode(this, "secret", 's')
74 , topiclockmode(this, "topiclock", 't')
79 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
81 ConfigTag* optionstag = ServerInstance->Config->ConfValue("options");
82 Implementation events[] = { I_OnCheckKey, I_OnCheckLimit, I_OnCheckChannelBan };
83 if (optionstag->getBool("invitebypassmodes", true))
84 ServerInstance->Modules.Attach(events, this, sizeof(events)/sizeof(Implementation));
87 for (unsigned int i = 0; i < sizeof(events)/sizeof(Implementation); i++)
88 ServerInstance->Modules.Detach(events[i], this);
92 irc::spacesepstream defaultstream(optionstag->getString("exemptchanops"));
93 insp::flat_map<std::string, char> exempts;
94 while (defaultstream.GetToken(current))
96 std::string::size_type pos = current.find(':');
97 if (pos == std::string::npos || (pos + 2) > current.size())
98 throw ModuleException("Invalid exemptchanops value '" + current + "' at " + optionstag->getTagLocation());
100 const std::string restriction = current.substr(0, pos);
101 const char prefix = current[pos + 1];
103 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Exempting prefix %c from %s", prefix, restriction.c_str());
104 exempts[restriction] = prefix;
106 exemptions.swap(exempts);
108 ConfigTag* securitytag = ServerInstance->Config->ConfValue("security");
109 const std::string announceinvites = securitytag->getString("announceinvites", "dynamic");
110 if (stdalgo::string::equalsci(announceinvites, "none"))
111 cmdinvite.announceinvites = Invite::ANNOUNCE_NONE;
112 else if (stdalgo::string::equalsci(announceinvites, "all"))
113 cmdinvite.announceinvites = Invite::ANNOUNCE_ALL;
114 else if (stdalgo::string::equalsci(announceinvites, "ops"))
115 cmdinvite.announceinvites = Invite::ANNOUNCE_OPS;
116 else if (stdalgo::string::equalsci(announceinvites, "dynamic"))
117 cmdinvite.announceinvites = Invite::ANNOUNCE_DYNAMIC;
119 throw ModuleException(announceinvites + " is an invalid <security:announceinvites> value, at " + securitytag->getTagLocation());
121 // In 2.0 we allowed limits of 0 to be set. This is non-standard behaviour
122 // and will be removed in the next major release.
123 limitmode.minlimit = optionstag->getBool("allowzerolimit", true) ? 0 : 1;
128 void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
130 tokens["KEYLEN"] = ConvToStr(ModeChannelKey::maxkeylen);
132 // Build a map of limits to their mode character.
133 insp::flat_map<int, std::string> limits;
134 const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
135 for (ModeParser::ListModeList::const_iterator iter = listmodes.begin(); iter != listmodes.end(); ++iter)
137 const unsigned int limit = (*iter)->GetLowerLimit();
138 limits[limit].push_back((*iter)->GetModeChar());
141 // Generate the MAXLIST token from the limits map.
142 std::string& buffer = tokens["MAXLIST"];
143 for (insp::flat_map<int, std::string>::const_iterator iter = limits.begin(); iter != limits.end(); ++iter)
146 buffer.push_back(',');
148 buffer.append(iter->second);
149 buffer.push_back(':');
150 buffer.append(ConvToStr(iter->first));
154 ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string&, std::string&, const std::string& keygiven) CXX11_OVERRIDE
157 return MOD_RES_PASSTHRU;
159 // Check whether the channel key is correct.
160 const std::string ckey = chan->GetModeParameter(&keymode);
163 ModResult MOD_RESULT;
164 FIRST_MOD_RESULT(OnCheckKey, MOD_RESULT, (user, chan, keygiven));
165 if (!MOD_RESULT.check(InspIRCd::TimingSafeCompare(ckey, keygiven)))
167 // If no key provided, or key is not the right one, and can't bypass +k (not invited or option not enabled)
168 user->WriteNumeric(ERR_BADCHANNELKEY, chan->name, "Cannot join channel (Incorrect channel key)");
173 // Check whether the invite only mode is set.
174 if (chan->IsModeSet(inviteonlymode))
176 ModResult MOD_RESULT;
177 FIRST_MOD_RESULT(OnCheckInvite, MOD_RESULT, (user, chan));
178 if (MOD_RESULT != MOD_RES_ALLOW)
180 user->WriteNumeric(ERR_INVITEONLYCHAN, chan->name, "Cannot join channel (Invite only)");
185 // Check whether the limit would be exceeded by this user joining.
186 if (chan->IsModeSet(limitmode))
188 ModResult MOD_RESULT;
189 FIRST_MOD_RESULT(OnCheckLimit, MOD_RESULT, (user, chan));
190 if (!MOD_RESULT.check(chan->GetUserCounter() < static_cast<size_t>(limitmode.ext.get(chan))))
192 user->WriteNumeric(ERR_CHANNELISFULL, chan->name, "Cannot join channel (Channel is full)");
197 // Everything looks okay.
198 return MOD_RES_PASSTHRU;
201 void OnPostJoin(Membership* memb) CXX11_OVERRIDE
203 Channel* const chan = memb->chan;
204 LocalUser* const localuser = IS_LOCAL(memb->user);
207 // Remove existing invite, if any
208 invapi.Remove(localuser, chan);
210 if (chan->topic.length())
211 Topic::ShowTopic(localuser, chan);
213 // Show all members of the channel, including invisible (+i) users
214 cmdnames.SendNames(localuser, chan, true);
218 ModResult OnCheckKey(User* user, Channel* chan, const std::string& keygiven) CXX11_OVERRIDE
220 // Hook only runs when being invited bypasses +bkl
221 return IsInvited(user, chan);
224 ModResult OnCheckChannelBan(User* user, Channel* chan) CXX11_OVERRIDE
226 // Hook only runs when being invited bypasses +bkl
227 return IsInvited(user, chan);
230 ModResult OnCheckLimit(User* user, Channel* chan) CXX11_OVERRIDE
232 // Hook only runs when being invited bypasses +bkl
233 return IsInvited(user, chan);
236 ModResult OnCheckInvite(User* user, Channel* chan) CXX11_OVERRIDE
239 return IsInvited(user, chan);
242 void OnUserDisconnect(LocalUser* user) CXX11_OVERRIDE
244 invapi.RemoveAll(user);
247 void OnChannelDelete(Channel* chan) CXX11_OVERRIDE
249 // Make sure the channel won't appear in invite lists from now on, don't wait for cull to unset the ext
250 invapi.RemoveAll(chan);
253 ModResult OnCheckExemption(User* user, Channel* chan, const std::string& restriction) CXX11_OVERRIDE
255 if (!exemptions.count(restriction))
256 return MOD_RES_PASSTHRU;
258 unsigned int mypfx = chan->GetPrefixValue(user);
259 char minmode = exemptions[restriction];
261 PrefixMode* mh = ServerInstance->Modes->FindPrefixMode(minmode);
262 if (mh && mypfx >= mh->GetPrefixRank())
263 return MOD_RES_ALLOW;
264 if (mh || minmode == '*')
266 return MOD_RES_PASSTHRU;
269 void Prioritize() CXX11_OVERRIDE
271 ServerInstance->Modules.SetPriority(this, I_OnPostJoin, PRIORITY_FIRST);
274 Version GetVersion() CXX11_OVERRIDE
276 return Version("Provides the INVITE, JOIN, KICK, NAMES, and TOPIC commands", VF_VENDOR|VF_CORE);
280 MODULE_INIT(CoreModChannel)