2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009-2010 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 #pragma comment(lib, "psapi.lib") // For GetProcessMemoryInfo()
32 class CommandStats : public Command
34 void DoStats(char statschar, User* user, string_list &results);
36 /** Constructor for stats.
38 CommandStats ( Module* parent) : Command(parent,"STATS",1,2) { syntax = "<stats-symbol> [<servername>]"; }
40 * @param parameters The parameters to the command
41 * @param user The user issuing the command
42 * @return A value from CmdResult to indicate command success or failure.
44 CmdResult Handle(const std::vector<std::string>& parameters, User *user);
45 RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
47 if (parameters.size() > 1)
48 return ROUTE_UNICAST(parameters[1]);
49 return ROUTE_LOCALONLY;
53 static void GenerateStatsLl(User* user, string_list& results, char c)
55 results.push_back(InspIRCd::Format("211 %s nick[ident@%s] sendq cmds_out bytes_out cmds_in bytes_in time_open", user->nick.c_str(), (c == 'l' ? "host" : "ip")));
57 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
58 for (UserManager::LocalList::const_iterator i = list.begin(); i != list.end(); ++i)
61 results.push_back("211 "+user->nick+" "+u->nick+"["+u->ident+"@"+(c == 'l' ? u->dhost : u->GetIPString())+"] "+ConvToStr(u->eh.getSendQSize())+" "+ConvToStr(u->cmds_out)+" "+ConvToStr(u->bytes_out)+" "+ConvToStr(u->cmds_in)+" "+ConvToStr(u->bytes_in)+" "+ConvToStr(ServerInstance->Time() - u->signon));
65 void CommandStats::DoStats(char statschar, User* user, string_list &results)
67 bool isPublic = ServerInstance->Config->UserStats.find(statschar) != std::string::npos;
68 bool isRemoteOper = IS_REMOTE(user) && (user->IsOper());
69 bool isLocalOperWithPrivs = IS_LOCAL(user) && user->HasPrivPermission("servers/auspex");
71 if (!isPublic && !isRemoteOper && !isLocalOperWithPrivs)
73 ServerInstance->SNO->WriteToSnoMask('t',
74 "%s '%c' denied for %s (%s@%s)",
75 (IS_LOCAL(user) ? "Stats" : "Remote stats"),
76 statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
77 results.push_back("481 " + user->nick + " :Permission Denied - STATS " + statschar + " requires the servers/auspex priv.");
82 FIRST_MOD_RESULT(OnStats, MOD_RESULT, (statschar, user, results));
83 if (MOD_RESULT == MOD_RES_DENY)
85 results.push_back("219 "+user->nick+" "+statschar+" :End of /STATS report");
86 ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",
87 (IS_LOCAL(user) ? "Stats" : "Remote stats"), statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
93 /* stats p (show listening ports) */
96 for (std::vector<ListenSocket*>::const_iterator i = ServerInstance->ports.begin(); i != ServerInstance->ports.end(); ++i)
98 ListenSocket* ls = *i;
99 std::string ip = ls->bind_addr;
102 else if (ip.find_first_of(':') != std::string::npos)
104 ip.insert(ip.begin(), '[');
105 ip.insert(ip.end(), ']');
107 std::string type = ls->bind_tag->getString("type", "clients");
108 std::string hook = ls->bind_tag->getString("ssl", "plaintext");
110 results.push_back("249 "+user->nick+" :"+ ip + ":"+ConvToStr(ls->bind_port)+
111 " (" + type + ", " + hook + ")");
116 /* These stats symbols must be handled by a linking module */
123 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); ++i)
125 ConnectClass* c = *i;
126 std::stringstream res;
127 res << "215 " << user->nick << " I " << c->name << ' ';
128 if (c->type == CC_ALLOW)
130 if (c->type == CC_DENY)
133 if (c->type == CC_NAMED)
138 res << ' ' << c->config->getString("port", "*") << ' ';
140 res << c->GetRecvqMax() << ' ' << c->GetSendqSoftMax() << ' ' << c->GetSendqHardMax()
141 << ' ' << c->GetCommandRate() << ' ' << c->GetPenaltyThreshold();
144 results.push_back(res.str());
152 for (ServerConfig::ClassVector::const_iterator i = ServerInstance->Config->Classes.begin(); i != ServerInstance->Config->Classes.end(); i++)
154 ConnectClass* c = *i;
155 results.push_back("215 "+user->nick+" i NOMATCH * "+c->GetHost()+" "+ConvToStr(c->limit ? c->limit : SocketEngine::GetMaxFds())+" "+ConvToStr(idx)+" "+ServerInstance->Config->ServerName+" *");
156 results.push_back("218 "+user->nick+" Y "+ConvToStr(idx)+" "+ConvToStr(c->GetPingTime())+" 0 "+ConvToStr(c->GetSendqHardMax())+" :"+
157 ConvToStr(c->GetRecvqMax())+" "+ConvToStr(c->GetRegTimeout()));
165 unsigned int idx = 0;
166 const UserManager::OperList& opers = ServerInstance->Users->all_opers;
167 for (UserManager::OperList::const_iterator i = opers.begin(); i != opers.end(); ++i)
170 if (!oper->server->IsULine())
172 LocalUser* lu = IS_LOCAL(oper);
173 results.push_back("249 " + user->nick + " :" + oper->nick + " (" + oper->ident + "@" + oper->dhost + ") Idle: " +
174 (lu ? ConvToStr(ServerInstance->Time() - lu->idle_lastmsg) + " secs" : "unavailable"));
178 results.push_back("249 "+user->nick+" :"+ConvToStr(idx)+" OPER(s)");
183 ServerInstance->XLines->InvokeStats("K",216,user,results);
186 ServerInstance->XLines->InvokeStats("G",223,user,results);
189 ServerInstance->XLines->InvokeStats("Q",217,user,results);
192 ServerInstance->XLines->InvokeStats("Z",223,user,results);
195 ServerInstance->XLines->InvokeStats("E",223,user,results);
199 const SocketEngine::Statistics& stats = SocketEngine::GetStats();
200 results.push_back("249 "+user->nick+" :Total events: "+ConvToStr(stats.TotalEvents));
201 results.push_back("249 "+user->nick+" :Read events: "+ConvToStr(stats.ReadEvents));
202 results.push_back("249 "+user->nick+" :Write events: "+ConvToStr(stats.WriteEvents));
203 results.push_back("249 "+user->nick+" :Error events: "+ConvToStr(stats.ErrorEvents));
207 /* stats m (list number of times each command has been used, plus bytecount) */
210 const CommandParser::CommandMap& commands = ServerInstance->Parser.GetCommands();
211 for (CommandParser::CommandMap::const_iterator i = commands.begin(); i != commands.end(); ++i)
213 if (i->second->use_count)
215 /* RPL_STATSCOMMANDS */
216 results.push_back("212 "+user->nick+" "+i->second->name+" "+ConvToStr(i->second->use_count));
222 /* stats z (debug and memory info) */
225 results.push_back("249 "+user->nick+" :Users: "+ConvToStr(ServerInstance->Users->GetUsers().size()));
226 results.push_back("249 "+user->nick+" :Channels: "+ConvToStr(ServerInstance->GetChans().size()));
227 results.push_back("249 "+user->nick+" :Commands: "+ConvToStr(ServerInstance->Parser.GetCommands().size()));
229 float kbitpersec_in, kbitpersec_out, kbitpersec_total;
230 char kbitpersec_in_s[30], kbitpersec_out_s[30], kbitpersec_total_s[30];
232 SocketEngine::GetStats().GetBandwidth(kbitpersec_in, kbitpersec_out, kbitpersec_total);
234 snprintf(kbitpersec_total_s, 30, "%03.5f", kbitpersec_total);
235 snprintf(kbitpersec_out_s, 30, "%03.5f", kbitpersec_out);
236 snprintf(kbitpersec_in_s, 30, "%03.5f", kbitpersec_in);
238 results.push_back("249 "+user->nick+" :Bandwidth total: "+ConvToStr(kbitpersec_total_s)+" kilobits/sec");
239 results.push_back("249 "+user->nick+" :Bandwidth out: "+ConvToStr(kbitpersec_out_s)+" kilobits/sec");
240 results.push_back("249 "+user->nick+" :Bandwidth in: "+ConvToStr(kbitpersec_in_s)+" kilobits/sec");
243 /* Moved this down here so all the not-windows stuff (look w00tie, I didn't say win32!) is in one ifndef.
244 * Also cuts out some identical code in both branches of the ifndef. -- Om
248 /* Not sure why we were doing '0' with a RUSAGE_SELF comment rather than just using RUSAGE_SELF -- Om */
249 if (!getrusage(RUSAGE_SELF,&R)) /* RUSAGE_SELF */
251 results.push_back("249 "+user->nick+" :Total allocation: "+ConvToStr(R.ru_maxrss)+"K");
252 results.push_back("249 "+user->nick+" :Signals: "+ConvToStr(R.ru_nsignals));
253 results.push_back("249 "+user->nick+" :Page faults: "+ConvToStr(R.ru_majflt));
254 results.push_back("249 "+user->nick+" :Swaps: "+ConvToStr(R.ru_nswap));
255 results.push_back("249 "+user->nick+" :Context Switches: Voluntary; "+ConvToStr(R.ru_nvcsw)+" Involuntary; "+ConvToStr(R.ru_nivcsw));
259 float n_elapsed = (ServerInstance->Time() - ServerInstance->stats.LastSampled.tv_sec) * 1000000
260 + (ServerInstance->Time_ns() - ServerInstance->stats.LastSampled.tv_nsec) / 1000;
261 float n_eaten = ((R.ru_utime.tv_sec - ServerInstance->stats.LastCPU.tv_sec) * 1000000 + R.ru_utime.tv_usec - ServerInstance->stats.LastCPU.tv_usec);
262 float per = (n_eaten / n_elapsed) * 100;
264 snprintf(percent, 30, "%03.5f%%", per);
265 results.push_back("249 "+user->nick+" :CPU Use (now): "+percent);
267 n_elapsed = ServerInstance->Time() - ServerInstance->startup_time;
268 n_eaten = (float)R.ru_utime.tv_sec + R.ru_utime.tv_usec / 100000.0;
269 per = (n_eaten / n_elapsed) * 100;
270 snprintf(percent, 30, "%03.5f%%", per);
271 results.push_back("249 "+user->nick+" :CPU Use (total): "+percent);
274 PROCESS_MEMORY_COUNTERS MemCounters;
275 if (GetProcessMemoryInfo(GetCurrentProcess(), &MemCounters, sizeof(MemCounters)))
277 results.push_back("249 "+user->nick+" :Total allocation: "+ConvToStr((MemCounters.WorkingSetSize + MemCounters.PagefileUsage) / 1024)+"K");
278 results.push_back("249 "+user->nick+" :Pagefile usage: "+ConvToStr(MemCounters.PagefileUsage / 1024)+"K");
279 results.push_back("249 "+user->nick+" :Page faults: "+ConvToStr(MemCounters.PageFaultCount));
282 FILETIME CreationTime;
286 LARGE_INTEGER ThisSample;
287 if(GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime) &&
288 QueryPerformanceCounter(&ThisSample))
290 KernelTime.dwHighDateTime += UserTime.dwHighDateTime;
291 KernelTime.dwLowDateTime += UserTime.dwLowDateTime;
292 double n_eaten = (double)( ( (uint64_t)(KernelTime.dwHighDateTime - ServerInstance->stats.LastCPU.dwHighDateTime) << 32 ) + (uint64_t)(KernelTime.dwLowDateTime - ServerInstance->stats.LastCPU.dwLowDateTime) )/100000;
293 double n_elapsed = (double)(ThisSample.QuadPart - ServerInstance->stats.LastSampled.QuadPart) / ServerInstance->stats.QPFrequency.QuadPart;
294 double per = (n_eaten/n_elapsed);
298 snprintf(percent, 30, "%03.5f%%", per);
299 results.push_back("249 "+user->nick+" :CPU Use (now): "+percent);
301 n_elapsed = ServerInstance->Time() - ServerInstance->startup_time;
302 n_eaten = (double)(( (uint64_t)(KernelTime.dwHighDateTime) << 32 ) + (uint64_t)(KernelTime.dwLowDateTime))/100000;
303 per = (n_eaten / n_elapsed);
304 snprintf(percent, 30, "%03.5f%%", per);
305 results.push_back("249 "+user->nick+" :CPU Use (total): "+percent);
313 results.push_back("249 "+user->nick+" :accepts "+ConvToStr(ServerInstance->stats.Accept)+" refused "+ConvToStr(ServerInstance->stats.Refused));
314 results.push_back("249 "+user->nick+" :unknown commands "+ConvToStr(ServerInstance->stats.Unknown));
315 results.push_back("249 "+user->nick+" :nick collisions "+ConvToStr(ServerInstance->stats.Collisions));
316 results.push_back("249 "+user->nick+" :dns requests "+ConvToStr(ServerInstance->stats.DnsGood+ServerInstance->stats.DnsBad)+" succeeded "+ConvToStr(ServerInstance->stats.DnsGood)+" failed "+ConvToStr(ServerInstance->stats.DnsBad));
317 results.push_back("249 "+user->nick+" :connection count "+ConvToStr(ServerInstance->stats.Connects));
318 results.push_back(InspIRCd::Format("249 %s :bytes sent %5.2fK recv %5.2fK", user->nick.c_str(),
319 ServerInstance->stats.Sent / 1024.0, ServerInstance->stats.Recv / 1024.0));
326 ConfigTagList tags = ServerInstance->Config->ConfTags("oper");
327 for(ConfigIter i = tags.first; i != tags.second; ++i)
329 ConfigTag* tag = i->second;
330 results.push_back("243 "+user->nick+" O "+tag->getString("host")+" * "+
331 tag->getString("name") + " " + tag->getString("type")+" 0");
337 for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->OperTypes.begin(); i != ServerInstance->Config->OperTypes.end(); ++i)
339 OperInfo* tag = i->second;
343 for(char c='A'; c <= 'z'; c++)
345 ModeHandler* mh = ServerInstance->Modes->FindMode(c, MODETYPE_USER);
346 if (mh && mh->NeedsOper() && tag->AllowedUserModes[c - 'A'])
348 mh = ServerInstance->Modes->FindMode(c, MODETYPE_CHANNEL);
349 if (mh && mh->NeedsOper() && tag->AllowedChanModes[c - 'A'])
352 results.push_back("243 "+user->nick+" O "+tag->name.c_str() + " " + umodes + " " + cmodes);
357 /* stats l (show user I/O stats) */
359 /* stats L (show user I/O stats with IP addresses) */
361 GenerateStatsLl(user, results, statschar);
364 /* stats u (show server uptime) */
367 unsigned int up = static_cast<unsigned int>(ServerInstance->Time() - ServerInstance->startup_time);
368 results.push_back(InspIRCd::Format("242 %s :Server up %u days, %.2u:%.2u:%.2u", user->nick.c_str(),
369 up / 86400, (up / 3600) % 24, (up / 60) % 60, up % 60));
377 results.push_back("219 "+user->nick+" "+statschar+" :End of /STATS report");
378 ServerInstance->SNO->WriteToSnoMask('t',"%s '%c' requested by %s (%s@%s)",
379 (IS_LOCAL(user) ? "Stats" : "Remote stats"), statschar, user->nick.c_str(), user->ident.c_str(), user->host.c_str());
383 CmdResult CommandStats::Handle (const std::vector<std::string>& parameters, User *user)
385 if (parameters.size() > 1 && parameters[1] != ServerInstance->Config->ServerName)
387 // Give extra penalty if a non-oper does /STATS <remoteserver>
388 LocalUser* localuser = IS_LOCAL(user);
389 if ((localuser) && (!user->IsOper()))
390 localuser->CommandFloodPenalty += 2000;
394 char search = parameters[0][0];
395 DoStats(search, user, values);
397 const std::string p = ":" + ServerInstance->Config->ServerName + " ";
398 for (size_t i = 0; i < values.size(); i++)
399 user->SendText(p + values[i]);
404 COMMAND_INIT(CommandStats)