]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_check.cpp
Fix the cloaking module on C++98 compilers.
[user/henk/code/inspircd.git] / src / modules / m_check.cpp
index 4b38c9fcb2f84b17916b563da6f4a555b394db30..f19f610e941ee14bd8e7a881d733b474d2c40825 100644 (file)
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017-2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
  *
- * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
+
 #include "inspircd.h"
-#include "wildcard.h"
+#include "listmode.h"
+
+enum
+{
+       RPL_CHECK = 802
+};
+
+class CheckContext
+{
+ private:
+       User* const user;
+       const std::string& target;
+
+       std::string FormatTime(time_t ts)
+       {
+               std::string timestr(InspIRCd::TimeString(ts, "%Y-%m-%d %H:%M:%S UTC (", true));
+               timestr.append(ConvToStr(ts));
+               timestr.push_back(')');
+               return timestr;
+       }
+
+ public:
+       CheckContext(User* u, const std::string& targetstr)
+               : user(u)
+               , target(targetstr)
+       {
+               Write("START", target);
+       }
+
+       ~CheckContext()
+       {
+               Write("END", target);
+       }
+
+       void Write(const std::string& type, const std::string& text)
+       {
+               user->WriteRemoteNumeric(RPL_CHECK, type, text);
+       }
+
+       void Write(const std::string& type, time_t ts)
+       {
+               user->WriteRemoteNumeric(RPL_CHECK, type, FormatTime(ts));
+       }
+
+       User* GetUser() const { return user; }
+
+       void DumpListMode(ListModeBase* mode, Channel* chan)
+       {
+               const ListModeBase::ModeList* list = mode->GetList(chan);
+               if (!list)
+                       return;
+
+               for (ListModeBase::ModeList::const_iterator i = list->begin(); i != list->end(); ++i)
+               {
+                       CheckContext::List listmode(*this, "listmode");
+                       listmode.Add(ConvToStr(mode->GetModeChar()));
+                       listmode.Add(i->mask);
+                       listmode.Add(i->setter);
+                       listmode.Add(FormatTime(i->time));
+                       listmode.Flush();
+               }
+       }
 
-/* $ModDesc: Provides the /check command to retrieve information on a user, channel, or IP address */
+       void DumpExt(Extensible* ext)
+       {
+               CheckContext::List extlist(*this, "metadata");
+               for(Extensible::ExtensibleStore::const_iterator i = ext->GetExtList().begin(); i != ext->GetExtList().end(); ++i)
+               {
+                       ExtensionItem* item = i->first;
+                       std::string value = item->ToHuman(ext, i->second);
+                       if (!value.empty())
+                               Write("meta:" + item->name, value);
+                       else if (!item->name.empty())
+                               extlist.Add(item->name);
+               }
+
+               extlist.Flush();
+       }
+
+       class List : public Numeric::GenericBuilder<' ', false, Numeric::WriteRemoteNumericSink>
+       {
+        public:
+               List(CheckContext& context, const char* checktype)
+                       : 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)
+               {
+                       GetNumeric().push(checktype).push(std::string());
+               }
+       };
+};
 
 /** Handle /CHECK
  */
-class cmd_check : public command_t
+class CommandCheck : public Command
 {
- public:
-       cmd_check (InspIRCd* Instance) : command_t(Instance,"CHECK", 'o', 1)
+       UserModeReference snomaskmode;
+
+       std::string GetSnomasks(User* user)
        {
-               this->source = "m_check.so";
-               syntax = "<nickname>|<ip>|<hostmask>|<channel>";
+               std::string ret;
+               if (snomaskmode)
+                       ret = snomaskmode->GetUserParameter(user);
+
+               if (ret.empty())
+                       ret = "+";
+               return ret;
        }
 
-       CmdResult Handle (const char** parameters, int pcnt, userrec *user)
+       static std::string GetAllowedOperOnlyModes(LocalUser* user, ModeType modetype)
        {
-               userrec *targuser;
-               chanrec *targchan;
-               std::string checkstr;
-               std::string chliststr;
+               std::string ret;
+               const ModeParser::ModeHandlerMap& modes = ServerInstance->Modes.GetModes(modetype);
+               for (ModeParser::ModeHandlerMap::const_iterator i = modes.begin(); i != modes.end(); ++i)
+               {
+                       const ModeHandler* const mh = i->second;
+                       if ((mh->NeedsOper()) && (user->HasModePermission(mh)))
+                               ret.push_back(mh->GetModeChar());
+               }
+               return ret;
+       }
+
+       static std::string GetAllowedOperOnlySnomasks(LocalUser* user)
+       {
+               std::string ret;
+               for (unsigned char sno = 'A'; sno <= 'z'; ++sno)
+                       if (ServerInstance->SNO->IsSnomaskUsable(sno) && user->HasSnomaskPermission(sno))
+                               ret.push_back(sno);
+               return ret;
+       }
 
-               char timebuf[60];
-               struct tm *mytime;
+ public:
+       CommandCheck(Module* parent)
+               : Command(parent,"CHECK", 1)
+               , snomaskmode(parent, "snomask")
+       {
+               flags_needed = 'o';
+               syntax = "<nick>|<ipmask>|<hostmask>|<channel> [<servername>]";
+       }
 
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
+       {
+               if (parameters.size() > 1 && !irc::equals(parameters[1], ServerInstance->Config->ServerName))
+                       return CMD_SUCCESS;
 
-               checkstr = "304 " + std::string(user->nick) + " :CHECK";
+               User *targuser;
+               Channel *targchan;
+               std::string chliststr;
 
                targuser = ServerInstance->FindNick(parameters[0]);
                targchan = ServerInstance->FindChan(parameters[0]);
 
                /*
                 * Syntax of a /check reply:
-                *  :server.name 304 target :CHECK START <target>
-                *  :server.name 304 target :CHECK <field> <value>
-                *  :server.name 304 target :CHECK END
+                *  :server.name 802 target START <target>
+                *  :server.name 802 target <field> :<value>
+                *  :server.name 802 target END <target>
                 */
 
-               user->WriteServ(checkstr + " START " + parameters[0]);
+               // Constructor sends START, destructor sends END
+               CheckContext context(user, parameters[0]);
 
                if (targuser)
                {
+                       LocalUser* loctarg = IS_LOCAL(targuser);
                        /* /check on a user */
-                       user->WriteServ(checkstr + " nuh " + targuser->GetFullHost());
-                       user->WriteServ(checkstr + " realnuh " + targuser->GetFullRealHost());
-                       user->WriteServ(checkstr + " realname " + targuser->fullname);
-                       user->WriteServ(checkstr + " modes +" + targuser->FormatModes());
-                       user->WriteServ(checkstr + " snomasks +" + targuser->FormatNoticeMasks());
-                       user->WriteServ(checkstr + " server " + targuser->server);
-                       if (targuser->awaymsg[0] != 0)
+                       context.Write("nuh", targuser->GetFullHost());
+                       context.Write("realnuh", targuser->GetFullRealHost());
+                       context.Write("realname", targuser->GetRealName());
+                       context.Write("modes", targuser->GetModeLetters());
+                       context.Write("snomasks", GetSnomasks(targuser));
+                       context.Write("server", targuser->server->GetName());
+                       context.Write("uid", targuser->uuid);
+                       context.Write("signon", targuser->signon);
+                       context.Write("nickts", targuser->age);
+                       if (loctarg)
+                               context.Write("lastmsg", loctarg->idle_lastmsg);
+
+                       if (targuser->IsAway())
                        {
                                /* user is away */
-                               user->WriteServ(checkstr + " awaymsg " + targuser->awaymsg);
+                               context.Write("awaytime", targuser->awaytime);
+                               context.Write("awaymsg", targuser->awaymsg);
                        }
-                       if (IS_OPER(targuser))
+
+                       if (targuser->IsOper())
                        {
+                               OperInfo* oper = targuser->oper;
                                /* user is an oper of type ____ */
-                               user->WriteServ(checkstr + " opertype " + irc::Spacify(targuser->oper));
+                               context.Write("opertype", oper->name);
+                               if (loctarg)
+                               {
+                                       context.Write("chanmodeperms", GetAllowedOperOnlyModes(loctarg, MODETYPE_CHANNEL));
+                                       context.Write("usermodeperms", GetAllowedOperOnlyModes(loctarg, MODETYPE_USER));
+                                       context.Write("snomaskperms", GetAllowedOperOnlySnomasks(loctarg));
+                                       context.Write("commandperms", oper->AllowedOperCommands.ToString());
+                                       context.Write("permissions", oper->AllowedPrivs.ToString());
+                               }
                        }
-                       if (IS_LOCAL(targuser))
+
+                       if (loctarg)
                        {
-                               /* port information is only held for a local user! */
-                               user->WriteServ(checkstr + " onport " + ConvToStr(targuser->GetPort()));
+                               context.Write("clientaddr", loctarg->client_sa.str());
+                               context.Write("serveraddr", loctarg->server_sa.str());
+
+                               std::string classname = loctarg->GetClass()->name;
+                               if (!classname.empty())
+                                       context.Write("connectclass", classname);
+
+                               context.Write("exempt", loctarg->exempt ? "yes" : "no");
                        }
+                       else
+                               context.Write("onip", targuser->GetIPString());
 
-                       chliststr = targuser->ChannelList(targuser);
-                       std::stringstream dump(chliststr);
+                       CheckContext::List chanlist(context, "onchans");
+                       for (User::ChanList::iterator i = targuser->chans.begin(); i != targuser->chans.end(); i++)
+                       {
+                               Membership* memb = *i;
+                               Channel* c = memb->chan;
+                               char prefix = memb->GetPrefixChar();
+                               if (prefix)
+                                       chliststr.push_back(prefix);
+                               chliststr.append(c->name);
+                               chanlist.Add(chliststr);
+                               chliststr.clear();
+                       }
+
+                       chanlist.Flush();
 
-                       ServerInstance->DumpText(user,checkstr + " onchans ", dump);
+                       context.DumpExt(targuser);
                }
                else if (targchan)
                {
                        /* /check on a channel */
-                       time_t creation_time = targchan->created;
-                       time_t topic_time = targchan->topicset;
-
-                       mytime = gmtime(&creation_time);
-                       strftime(timebuf, 59, "%Y/%m/%d - %H:%M:%S", mytime);
-                       user->WriteServ(checkstr + " created " + timebuf);
+                       context.Write("createdat", targchan->age);
 
-                       if (targchan->topic[0] != 0)
+                       if (!targchan->topic.empty())
                        {
                                /* there is a topic, assume topic related information exists */
-                               user->WriteServ(checkstr + " topic " + targchan->topic);
-                               user->WriteServ(checkstr + " topic_setby " + targchan->setby);
-                               mytime = gmtime(&topic_time);
-                               strftime(timebuf, 59, "%Y/%m/%d - %H:%M:%S", mytime);
-                               user->WriteServ(checkstr + " topic_setat " + timebuf);
+                               context.Write("topic", targchan->topic);
+                               context.Write("topic_setby", targchan->setby);
+                               context.Write("topic_setat", targchan->topicset);
                        }
 
-                       user->WriteServ(checkstr + " modes " + targchan->ChanModes(true));
-                       user->WriteServ(checkstr + " membercount " + ConvToStr(targchan->GetUserCounter()));
-                       
+                       context.Write("modes", targchan->ChanModes(true));
+                       context.Write("membercount", ConvToStr(targchan->GetUserCounter()));
+
                        /* now the ugly bit, spool current members of a channel. :| */
 
-                       CUList *ulist= targchan->GetUsers();
+                       const Channel::MemberMap& ulist = targchan->GetUsers();
 
                        /* note that unlike /names, we do NOT check +i vs in the channel */
-                       for (CUList::iterator i = ulist->begin(); i != ulist->end(); i++)
+                       for (Channel::MemberMap::const_iterator i = ulist.begin(); i != ulist.end(); ++i)
                        {
-                               char tmpbuf[MAXBUF];
                                /*
                                 * Unlike Asuka, I define a clone as coming from the same host. --w00t
                                 */
-                               snprintf(tmpbuf, MAXBUF, "%lu    %s%s (%s@%s) %s ", i->first->GlobalCloneCount(), targchan->GetAllPrefixChars(i->first), i->first->nick, i->first->ident, i->first->dhost, i->first->fullname);
-                               user->WriteServ(checkstr + " member " + tmpbuf);
+                               const UserManager::CloneCounts& clonecount = ServerInstance->Users->GetCloneCounts(i->first);
+                               context.Write("member", InspIRCd::Format("%u %s%s (%s)", clonecount.global,
+                                       i->second->GetAllPrefixChars().c_str(), i->first->GetFullHost().c_str(),
+                                       i->first->GetRealName().c_str()));
                        }
+
+                       const ModeParser::ListModeList& listmodes = ServerInstance->Modes->GetListModes();
+                       for (ModeParser::ListModeList::const_iterator i = listmodes.begin(); i != listmodes.end(); ++i)
+                               context.DumpListMode(*i, targchan);
+
+                       context.DumpExt(targchan);
                }
                else
                {
@@ -129,81 +299,49 @@ class cmd_check : public command_t
                        long x = 0;
 
                        /* hostname or other */
-                       for (user_hash::const_iterator a = ServerInstance->clientlist->begin(); a != ServerInstance->clientlist->end(); a++)
+                       const user_hash& users = ServerInstance->Users->GetUsers();
+                       for (user_hash::const_iterator a = users.begin(); a != users.end(); ++a)
                        {
-                               if (match(a->second->host, parameters[0]) || match(a->second->dhost, parameters[0]))
+                               if (InspIRCd::Match(a->second->GetRealHost(), parameters[0], ascii_case_insensitive_map) || InspIRCd::Match(a->second->GetDisplayedHost(), parameters[0], ascii_case_insensitive_map))
                                {
                                        /* host or vhost matches mask */
-                                       user->WriteServ(checkstr + " match " + ConvToStr(++x) + " " + a->second->GetFullRealHost());
+                                       context.Write("match", ConvToStr(++x) + " " + a->second->GetFullRealHost() + " " + a->second->GetIPString() + " " + a->second->GetRealName());
                                }
                                /* IP address */
-                               else if (match(a->second->GetIPString(), parameters[0], true))
+                               else if (InspIRCd::MatchCIDR(a->second->GetIPString(), parameters[0]))
                                {
                                        /* same IP. */
-                                       user->WriteServ(checkstr + " match " + ConvToStr(++x) + " " + a->second->GetFullRealHost());
+                                       context.Write("match", ConvToStr(++x) + " " + a->second->GetFullRealHost() + " " + a->second->GetIPString() + " " + a->second->GetRealName());
                                }
                        }
 
-                       user->WriteServ(checkstr + " matches " + ConvToStr(x));
+                       context.Write("matches", ConvToStr(x));
                }
 
-               user->WriteServ(checkstr + " END " + std::string(parameters[0]));
-
-               return CMD_LOCALONLY;
+               // END is sent by the CheckContext destructor
+               return CMD_SUCCESS;
        }
-};
 
-
-class ModuleCheck : public Module
-{
- private:
-       cmd_check *mycommand;
- public:
-       ModuleCheck(InspIRCd* Me) : Module::Module(Me)
-       {
-               
-               mycommand = new cmd_check(ServerInstance);
-               ServerInstance->AddCommand(mycommand);
-       }
-       
-       virtual ~ModuleCheck()
-       {
-       }
-       
-       virtual Version GetVersion()
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
-               return Version(1, 1, 0, 0, VF_VENDOR, API_VERSION);
+               if ((parameters.size() > 1) && (parameters[1].find('.') != std::string::npos))
+                       return ROUTE_OPT_UCAST(parameters[1]);
+               return ROUTE_LOCALONLY;
        }
-
-       void Implements(char* List)
-       {
-               /* we don't hook anything, nothing required */
-       }
-       
 };
 
-
-
-class ModuleCheckFactory : public ModuleFactory
+class ModuleCheck : public Module
 {
+       CommandCheck mycommand;
  public:
-       ModuleCheckFactory()
+       ModuleCheck() : mycommand(this)
        {
        }
-       
-       ~ModuleCheckFactory()
-       {
-       }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
+
+       Version GetVersion() CXX11_OVERRIDE
        {
-               return new ModuleCheck(Me);
+               return Version("Adds the /CHECK command which allows server operators to look up details about a channel, user, IP address, or hostname.", VF_VENDOR|VF_OPTCOMMON);
        }
-       
 };
 
-extern "C" void * init_module( void )
-{
-       return new ModuleCheckFactory;
-}
-
+MODULE_INIT(ModuleCheck)