2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com>
5 * Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
6 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
7 * Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
8 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
9 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
10 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
11 * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
13 * This file is part of InspIRCd. InspIRCd is free software: you can
14 * redistribute it and/or modify it under the terms of the GNU General Public
15 * License as published by the Free Software Foundation, version 2.
17 * This program is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 const std::string& target;
41 std::string FormatTime(time_t ts)
43 std::string timestr(InspIRCd::TimeString(ts, "%Y-%m-%d %H:%M:%S UTC (", true));
44 timestr.append(ConvToStr(ts));
45 timestr.push_back(')');
50 CheckContext(User* u, const std::string& targetstr)
54 Write("START", target);
62 void Write(const std::string& type, const std::string& text)
64 user->WriteRemoteNumeric(RPL_CHECK, type, text);
67 void Write(const std::string& type, time_t ts)
69 user->WriteRemoteNumeric(RPL_CHECK, type, FormatTime(ts));
72 User* GetUser() const { return user; }
74 void DumpListMode(ListModeBase* mode, Channel* chan)
76 const ListModeBase::ModeList* list = mode->GetList(chan);
80 for (ListModeBase::ModeList::const_iterator i = list->begin(); i != list->end(); ++i)
82 CheckContext::List listmode(*this, "listmode");
83 listmode.Add(ConvToStr(mode->GetModeChar()));
84 listmode.Add(i->mask);
85 listmode.Add(i->setter);
86 listmode.Add(FormatTime(i->time));
91 void DumpExt(Extensible* ext)
93 CheckContext::List extlist(*this, "metadata");
94 for(Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); ++i)
96 ExtensionItem* item = i->first;
97 std::string value = item->ToHuman(ext, i->second);
99 Write("meta:" + item->name, value);
100 else if (!item->name.empty())
101 extlist.Add(item->name);
107 class List : public Numeric::GenericBuilder<' ', false, Numeric::WriteRemoteNumericSink>
110 List(CheckContext& context, const char* checktype)
111 : Numeric::GenericBuilder<' ', false, Numeric::WriteRemoteNumericSink>(Numeric::WriteRemoteNumericSink(context.GetUser()), RPL_CHECK, false, (IS_LOCAL(context.GetUser()) ? context.GetUser()->nick.length() : ServerInstance->Config->Limits.NickMax) + strlen(checktype) + 1)
113 GetNumeric().push(checktype).push(std::string());
120 class CommandCheck : public Command
122 UserModeReference snomaskmode;
124 std::string GetSnomasks(User* user)
128 ret = snomaskmode->GetUserParameter(user);
135 static std::string GetAllowedOperOnlyModes(LocalUser* user, ModeType modetype)
138 const ModeParser::ModeHandlerMap& modes = ServerInstance->Modes.GetModes(modetype);
139 for (ModeParser::ModeHandlerMap::const_iterator i = modes.begin(); i != modes.end(); ++i)
141 const ModeHandler* const mh = i->second;
142 if ((mh->NeedsOper()) && (user->HasModePermission(mh)))
143 ret.push_back(mh->GetModeChar());
149 CommandCheck(Module* parent)
150 : Command(parent,"CHECK", 1)
151 , snomaskmode(parent, "snomask")
153 flags_needed = 'o'; syntax = "<nick>|<ipmask>|<hostmask>|<channel> [<servername>]";
156 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
158 if (parameters.size() > 1 && !irc::equals(parameters[1], ServerInstance->Config->ServerName))
163 std::string chliststr;
165 targuser = ServerInstance->FindNick(parameters[0]);
166 targchan = ServerInstance->FindChan(parameters[0]);
169 * Syntax of a /check reply:
170 * :server.name 802 target START <target>
171 * :server.name 802 target <field> :<value>
172 * :server.name 802 target END <target>
175 // Constructor sends START, destructor sends END
176 CheckContext context(user, parameters[0]);
180 LocalUser* loctarg = IS_LOCAL(targuser);
181 /* /check on a user */
182 context.Write("nuh", targuser->GetFullHost());
183 context.Write("realnuh", targuser->GetFullRealHost());
184 context.Write("realname", targuser->GetRealName());
185 context.Write("modes", targuser->GetModeLetters());
186 context.Write("snomasks", GetSnomasks(targuser));
187 context.Write("server", targuser->server->GetName());
188 context.Write("uid", targuser->uuid);
189 context.Write("signon", targuser->signon);
190 context.Write("nickts", targuser->age);
192 context.Write("lastmsg", loctarg->idle_lastmsg);
194 if (targuser->IsAway())
197 context.Write("awaytime", targuser->awaytime);
198 context.Write("awaymsg", targuser->awaymsg);
201 if (targuser->IsOper())
203 OperInfo* oper = targuser->oper;
204 /* user is an oper of type ____ */
205 context.Write("opertype", oper->name);
208 context.Write("chanmodeperms", GetAllowedOperOnlyModes(loctarg, MODETYPE_CHANNEL));
209 context.Write("usermodeperms", GetAllowedOperOnlyModes(loctarg, MODETYPE_USER));
210 context.Write("commandperms", oper->AllowedOperCommands.ToString());
211 context.Write("permissions", oper->AllowedPrivs.ToString());
217 context.Write("clientaddr", loctarg->client_sa.str());
218 context.Write("serveraddr", loctarg->server_sa.str());
220 std::string classname = loctarg->GetClass()->name;
221 if (!classname.empty())
222 context.Write("connectclass", classname);
225 context.Write("onip", targuser->GetIPString());
227 CheckContext::List chanlist(context, "onchans");
228 for (User::ChanList::iterator i = targuser->chans.begin(); i != targuser->chans.end(); i++)
230 Membership* memb = *i;
231 Channel* c = memb->chan;
232 char prefix = memb->GetPrefixChar();
234 chliststr.push_back(prefix);
235 chliststr.append(c->name);
236 chanlist.Add(chliststr);
242 context.DumpExt(targuser);
246 /* /check on a channel */
247 context.Write("createdat", targchan->age);
249 if (!targchan->topic.empty())
251 /* there is a topic, assume topic related information exists */
252 context.Write("topic", targchan->topic);
253 context.Write("topic_setby", targchan->setby);
254 context.Write("topic_setat", targchan->topicset);
257 context.Write("modes", targchan->ChanModes(true));
258 context.Write("membercount", ConvToStr(targchan->GetUserCounter()));
260 /* now the ugly bit, spool current members of a channel. :| */
262 const Channel::MemberMap& ulist = targchan->GetUsers();
264 /* note that unlike /names, we do NOT check +i vs in the channel */
265 for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
268 * Unlike Asuka, I define a clone as coming from the same host. --w00t
270 const UserManager::CloneCounts& clonecount = ServerInstance->Users->GetCloneCounts(i->first);
271 context.Write("member", InspIRCd::Format("%u %s%s (%s)", clonecount.global,
272 i->second->GetAllPrefixChars().c_str(), i->first->GetFullHost().c_str(),
273 i->first->GetRealName().c_str()));
276 const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
277 for (ModeParser::ListModeList::const_iterator i = listmodes.begin(); i != listmodes.end(); ++i)
278 context.DumpListMode(*i, targchan);
280 context.DumpExt(targchan);
284 /* /check on an IP address, or something that doesn't exist */
287 /* hostname or other */
288 const user_hash& users = ServerInstance->Users->GetUsers();
289 for (user_hash::const_iterator a = users.begin(); a != users.end(); ++a)
291 if (InspIRCd::Match(a->second->GetRealHost(), parameters[0], ascii_case_insensitive_map) || InspIRCd::Match(a->second->GetDisplayedHost(), parameters[0], ascii_case_insensitive_map))
293 /* host or vhost matches mask */
294 context.Write("match", ConvToStr(++x) + " " + a->second->GetFullRealHost() + " " + a->second->GetIPString() + " " + a->second->GetRealName());
297 else if (InspIRCd::MatchCIDR(a->second->GetIPString(), parameters[0]))
300 context.Write("match", ConvToStr(++x) + " " + a->second->GetFullRealHost() + " " + a->second->GetIPString() + " " + a->second->GetRealName());
304 context.Write("matches", ConvToStr(x));
307 // END is sent by the CheckContext destructor
311 RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
313 if ((parameters.size() > 1) && (parameters[1].find('.') != std::string::npos))
314 return ROUTE_OPT_UCAST(parameters[1]);
315 return ROUTE_LOCALONLY;
319 class ModuleCheck : public Module
321 CommandCheck mycommand;
323 ModuleCheck() : mycommand(this)
327 Version GetVersion() CXX11_OVERRIDE
329 return Version("Provides the CHECK command to view user, channel, IP address or hostname information", VF_VENDOR|VF_OPTCOMMON);
333 MODULE_INIT(ModuleCheck)